Skip to content

Commit 23b665f

Browse files
authored
Consistent notes and warnings (#608)
* Consistent notes and warnings * Consistent notes and warnings
1 parent 54a3d93 commit 23b665f

File tree

1 file changed

+9
-8
lines changed

1 file changed

+9
-8
lines changed

README.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -99,10 +99,10 @@ Amazon Linux 1 uses glibc version 2.17, while Rust binaries need glibc version 2
9999
If you are building for Amazon Linux 1, or you want to support both Amazon Linux 2 and 1, run:
100100

101101
```bash
102-
# Note: replace "aarch64" with "x86_64" if you are building for x86_64
103102
cargo lambda build --release --target aarch64-unknown-linux-gnu.2.17
104103
```
105-
104+
> **Note**
105+
> Replace "aarch64" with "x86_64" if you are building for x86_64
106106
### 2. Deploying the binary to AWS Lambda
107107

108108
For [a custom runtime](https://docs.aws.amazon.com/lambda/latest/dg/runtimes-custom.html), AWS Lambda looks for an executable called `bootstrap` in the deployment package zip. Rename the generated executable to `bootstrap` and add it to a zip archive.
@@ -118,7 +118,7 @@ cargo lambda deploy \
118118
--iam-role arn:aws:iam::XXXXXXXXXXXXX:role/your_lambda_execution_role
119119
```
120120

121-
> **warning**
121+
> **Warning**
122122
> Make sure to replace the execution role with an existing role in your account!
123123
124124
This command will create a Lambda function with the same name of your rust package. You can change the name
@@ -130,7 +130,7 @@ cargo lambda deploy \
130130
my-first-lambda-function
131131
```
132132

133-
> **info**
133+
> **Note**
134134
> See other deployment options in [the Cargo Lambda documentation](https://www.cargo-lambda.info/commands/deploy.html).
135135
136136
You can test the function with the [invoke subcommand](https://www.cargo-lambda.info/commands/invoke.html):
@@ -165,7 +165,7 @@ $ aws lambda create-function --function-name rustTest \
165165
--tracing-config Mode=Active
166166
```
167167

168-
> **warning**
168+
> **Warning**
169169
> Make sure to replace the execution role with an existing role in your account!
170170
171171
You can now test the function using the AWS CLI or the AWS Lambda console
@@ -179,8 +179,8 @@ $ aws lambda invoke
179179
$ cat output.json # Prints: {"msg": "Command Say Hi! executed."}
180180
```
181181

182-
**Note:** `--cli-binary-format raw-in-base64-out` is a required
183-
argument when using the AWS CLI version 2. [More Information](https://docs.aws.amazon.com/cli/latest/userguide/cliv2-migration.html#cliv2-migration-binaryparam)
182+
> **Note**
183+
> `--cli-binary-format raw-in-base64-out` is a required argument when using the AWS CLI version 2. [More Information](https://docs.aws.amazon.com/cli/latest/userguide/cliv2-migration.html#cliv2-migration-binaryparam)
184184
185185
#### 2.3. AWS Serverless Application Model (SAM)
186186

@@ -360,7 +360,8 @@ curl -v -X POST \
360360
-d '{ "command": "hi" }'
361361
```
362362

363-
> **warning** Do not remove the `content-type` header. It is necessary to instruct the function how to deserialize the request body.
363+
> **Warning**
364+
> Do not remove the `content-type` header. It is necessary to instruct the function how to deserialize the request body.
364365
365366
You can read more about how [cargo lambda watch](https://www.cargo-lambda.info/commands/watch.html) and [cargo lambda invoke](https://www.cargo-lambda.info/commands/invoke.html) work on the project's [documentation page](https://www.cargo-lambda.info).
366367

0 commit comments

Comments
 (0)