Skip to content

Commit

Permalink
Rust: Create README.md for Lambda Function example (awsdocs#6893)
Browse files Browse the repository at this point in the history
* Rust: Create README.md for Lambda Function example
  • Loading branch information
DavidSouther committed Sep 20, 2024
1 parent bded041 commit 6a5af5c
Show file tree
Hide file tree
Showing 2 changed files with 58 additions and 0 deletions.
1 change: 1 addition & 0 deletions rustv1/examples/lambda/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
Shows how to use the AWS SDK for Rust to work with AWS Lambda.

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

_Lambda allows you to run code without provisioning or managing servers._
Expand Down
57 changes: 57 additions & 0 deletions rustv1/lambda/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
# Rust Lambda Function

## Overview

This example shows how to use Rust in a lambda function.
_Lambda allows you to run code without provisioning or managing servers._

## ⚠ Important

* 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/).
* Running the tests might result in charges to your AWS account.
* 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).
* 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).

<!--custom.important.start-->
<!--custom.important.end-->

## Code examples

### Prerequisites

For prerequisites, see the [README](../../README.md#Prerequisites) in the `rustv1` folder.


<!--custom.prerequisites.start-->

Additionally, to compile Lambda functions written in the Rust programming language, use [Cargo Lambda](https://www.cargo-lambda.info/).

<!--custom.prerequisites.end-->


### Tests

⚠ Running tests might result in charges to your AWS account.


To find instructions for running these tests, see the [README](../../README.md#Tests)
in the `rustv1` folder.



<!--custom.tests.start-->
<!--custom.tests.end-->

## Additional resources

- [Lambda Developer Guide](https://docs.aws.amazon.com/lambda/latest/dg/welcome.html)
- [Lambda API Reference](https://docs.aws.amazon.com/lambda/latest/dg/API_Reference.html)
<!--custom.resources.start-->
- [Cargo Lambda](https://cargo-lambda.info)
<!--custom.resources.end-->

---

Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.

SPDX-License-Identifier: Apache-2.0

0 comments on commit 6a5af5c

Please sign in to comment.