Skip to content

HOWTO Add instruction for using the aws-sam-cli, It is a wrapper for cloud … #831

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 12, 2019
+30 −2
Merged

HOWTO Add instruction for using the aws-sam-cli, It is a wrapper for cloud … #831

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9b33103
Add instruction for using the aws-sam-cli, It is a wrapper for cloud …
Feb 28, 2019
6182615
Reference the github repo, add --s3-prefix to organize the s3 bucket,…
Mar 4, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 30 additions & 2 deletions HOWTO.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,15 @@ resources for you.
The remainder of this document explains how to write SAM templates and
deploy them via AWS CloudFormation.

## Writing SAM Template
## Getting started with the SAM Template
Check out the [latest specification](versions/2016-10-31.md) for details on how to write a SAM template


You could also use the [aws-sam-cli](https://github.com/awslabs/aws-sam-cli) to get started

```shell
$ sam init --runtime python3.7
```
## Packing Artifacts
Before you can deploy a SAM template, you should first upload your Lambda
function code zip and API's OpenAPI File to S3. Set the `CodeUri` and
Expand Down Expand Up @@ -47,9 +53,22 @@ packaged template that can be readily deployed to CloudFormation.
$ aws cloudformation package \
--template-file /path_to_template/template.yaml \
--s3-bucket bucket-name \
--s3-prefix appname/branchname/version
--output-template-file packaged-template.yaml
```

Or using the aws-sam-cli

```bash
$ sam package \
--template-file /path_to_template/template.yaml \
--s3-bucket bucket-name \
--s3-prefix appname/branchname/version
--output-template-file packaged-template.yaml
```



The packaged template will look something like this:
```YAML
MyLambdaFunction:
Expand Down Expand Up @@ -80,7 +99,16 @@ $ aws cloudformation deploy \
--capabilities CAPABILITY_IAM
```

Refer to the [documentation](http://docs.aws.amazon.com/cli/latest/reference/cloudformation/deploy/index.html) for more details.
Or using aws-sam-cli

```bash
$ sam deploy \
--template-file /path_to_template/packaged-template.yaml \
--stack-name my-new-stack
--capabilities CAPABILITY_IAM
```

Refer to the [cloudformation documentation](http://docs.aws.amazon.com/cli/latest/reference/cloudformation/deploy/index.html) and [samcli](https://github.com/awslabs/aws-sam-cli) for more details.

## Using Intrinsic Functions
CloudFormation provides handy functions that you can use to generate values at runtime. These are called [Intrinsic Functions](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference.html). Since SAM is deployed using CloudFormation, you can use these intrinsic functions within SAM as well. Here are some examples:
Expand Down