Skip to content

Commit 6a5af5c

Browse files
authored
Rust: Create README.md for Lambda Function example (#6893)
* Rust: Create README.md for Lambda Function example
1 parent bded041 commit 6a5af5c

File tree

2 files changed

+58
-0
lines changed

2 files changed

+58
-0
lines changed

rustv1/examples/lambda/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
Shows how to use the AWS SDK for Rust to work with AWS Lambda.
66

77
<!--custom.overview.start-->
8+
For an example of using Rust in a lambda function, see [this example](../../lambda).
89
<!--custom.overview.end-->
910

1011
_Lambda allows you to run code without provisioning or managing servers._

rustv1/lambda/README.md

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
# Rust Lambda Function
2+
3+
## Overview
4+
5+
This example shows how to use Rust in a lambda function.
6+
_Lambda allows you to run code without provisioning or managing servers._
7+
8+
## ⚠ Important
9+
10+
* Running this code might result in charges to your AWS account. For more details, see [AWS Pricing](https://aws.amazon.com/pricing/) and [Free Tier](https://aws.amazon.com/free/).
11+
* Running the tests might result in charges to your AWS account.
12+
* We recommend that you grant your code least privilege. At most, grant only the minimum permissions required to perform the task. For more information, see [Grant least privilege](https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html#grant-least-privilege).
13+
* This code is not tested in every AWS Region. For more information, see [AWS Regional Services](https://aws.amazon.com/about-aws/global-infrastructure/regional-product-services).
14+
15+
<!--custom.important.start-->
16+
<!--custom.important.end-->
17+
18+
## Code examples
19+
20+
### Prerequisites
21+
22+
For prerequisites, see the [README](../../README.md#Prerequisites) in the `rustv1` folder.
23+
24+
25+
<!--custom.prerequisites.start-->
26+
27+
Additionally, to compile Lambda functions written in the Rust programming language, use [Cargo Lambda](https://www.cargo-lambda.info/).
28+
29+
<!--custom.prerequisites.end-->
30+
31+
32+
### Tests
33+
34+
⚠ Running tests might result in charges to your AWS account.
35+
36+
37+
To find instructions for running these tests, see the [README](../../README.md#Tests)
38+
in the `rustv1` folder.
39+
40+
41+
42+
<!--custom.tests.start-->
43+
<!--custom.tests.end-->
44+
45+
## Additional resources
46+
47+
- [Lambda Developer Guide](https://docs.aws.amazon.com/lambda/latest/dg/welcome.html)
48+
- [Lambda API Reference](https://docs.aws.amazon.com/lambda/latest/dg/API_Reference.html)
49+
<!--custom.resources.start-->
50+
- [Cargo Lambda](https://cargo-lambda.info)
51+
<!--custom.resources.end-->
52+
53+
---
54+
55+
Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
56+
57+
SPDX-License-Identifier: Apache-2.0

0 commit comments

Comments
 (0)