-
Notifications
You must be signed in to change notification settings - Fork 4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(aws-sam): reference related modules in README (#2502)
Add references to reference documentation of related CDK modules.
- Loading branch information
Elad Ben-Israel
authored
May 8, 2019
1 parent
f9c6ad6
commit 96d58d8
Showing
1 changed file
with
11 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,17 @@ | ||
## AWS Serverless Application Model Construct Library | ||
|
||
This module includes low-level constructs that synthesize into `AWS::Serverless` resources. | ||
|
||
```ts | ||
const sam = require('@aws-cdk/aws-sam'); | ||
``` | ||
|
||
Note: we recommended to use `@aws-cdk/aws-lambda`, `aws-cdk/aws-lambda-event-sources` and `@aws-cdk/aws-apigateway` packages to build 'serverless' applications with the CDK instead of the `AWS::Serverless` resources exposes by `@aws-cdk/aws-sam`. | ||
### Related | ||
|
||
The following AWS CDK modules include constructs that can be used to work with Amazon API Gateway and AWS Lambda: | ||
|
||
* [aws-lambda](https://docs.aws.amazon.com/cdk/api/latest/docs/aws-lambda-readme.html): define AWS Lambda functions | ||
* [aws-lambda-event-sources](https://docs.aws.amazon.com/cdk/api/latest/docs/aws-lambda-event-sources-readme.html): classes that allow using various AWS services as event sources for AWS Lambda functions | ||
* [aws-apigateway](https://docs.aws.amazon.com/cdk/api/latest/docs/aws-apigateway-readme.html): define APIs through Amazon API Gateway | ||
* [aws-codedeploy](https://docs.aws.amazon.com/cdk/api/latest/docs/aws-codedeploy-readme.html#lambda-applications): define AWS Lambda deployment with traffic shifting support | ||
|