README.md
1<p align="center">
2</p>
3
4# AWS Serverless Application Model (AWS SAM)
5
6
7
8[](https://codecov.io/gh/aws/serverless-application-model)
9
10The AWS Serverless Application Model (SAM) is an open-source framework for building serverless applications.
11It provides shorthand syntax to express functions, APIs, databases, and event source mappings.
12With just a few lines of configuration, you can define the application you want and model it.
13
14[](https://www.youtube.com/watch?v=1dzihtC5LJ0)
15
16## Get Started
17
18To get started with building SAM-based applications, use the SAM CLI. SAM CLI provides a Lambda-like execution
19environment that lets you locally build, test, debug, and deploy applications defined by SAM templates.
20
21* [Install SAM CLI](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/serverless-sam-cli-install.html)
22* [Build & Deploy a "Hello World" Web App](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/serverless-quick-start.html)
23* [Install AWS Toolkit](https://aws.amazon.com/getting-started/tools-sdks/#IDE_and_IDE_Toolkits) to use SAM with your favorite IDEs.
24
25
26**Next Steps:** Learn to build a more complex serverless application.
27* [Extract text from images and store in a database](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/serverless-example-s3.html) using Amazon S3 and Amazon Rekognition services.
28* [Detect when records are added to a database](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/serverless-example-ddb.html) using Amazon DynamoDB database and asynchronous stream processing.
29
30
31**Detailed References:** Explains SAM commands and usage in depth.
32* [CLI Commands](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/serverless-sam-cli-command-reference.html)
33* [SAM Template Specification](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-specification.html)
34* [Policy Templates](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/serverless-policy-templates.html)
35
36## Why SAM
37
38+ **Single\-deployment configuration**\. SAM makes it easy to organize related components and resources, and operate on a single stack\. You can use SAM to share configuration \(such as memory and timeouts\) between resources, and deploy all related resources together as a single, versioned entity\.
39
40+ **Local debugging and testing**\. Use SAM CLI to locally build, test, and debug SAM applications on a Lambda-like execution environment. It tightens the development loop by helping you find & troubleshoot issues locally that you might otherwise identify only after deploying to the cloud.
41
42+ **Deep integration with development tools**. You can use SAM with a suite of tools you love and use.
43 + IDEs: [PyCharm](https://aws.amazon.com/pycharm/), [IntelliJ](https://aws.amazon.com/intellij/), [Visual Studio Code](https://aws.amazon.com/visualstudiocode/), [Visual Studio](https://aws.amazon.com/visualstudio/), [AWS Cloud9](https://aws.amazon.com/cloud9/)
44 + Build: [CodeBuild](https://docs.aws.amazon.com/codebuild/latest/userguide/)
45 + Deploy: [CodeDeploy](https://docs.aws.amazon.com/codedeploy/latest/userguide/), [Jenkins](https://wiki.jenkins.io/display/JENKINS/AWS+SAM+Plugin)
46 + Continuous Delivery Pipelines: [CodePipeline](https://docs.aws.amazon.com/codepipeline/latest/userguide/)
47 + Discover Serverless Apps & Patterns: [AWS Serverless Application Repository](https://docs.aws.amazon.com/serverlessrepo/latest/devguide/)
48
49+ **Built\-in best practices**\. You can use SAM to define and deploy your infrastructure as configuration. This makes it possible for you to use and enforce best practices through code reviews. Also, with a few lines of configuration, you can enable safe deployments through CodeDeploy, and can enable tracing using AWS X\-Ray\.
50
51+ **Extension of AWS CloudFormation**\. Because SAM is an extension of AWS CloudFormation, you get the reliable deployment capabilities of AWS CloudFormation\. You can define resources by using CloudFormation in your SAM template\. Also, you can use the full suite of resources, intrinsic functions, and other template features that are available in CloudFormation\.
52
53## What is this Github repository? ��
54
55This GitHub repository contains the SAM Specification, the Python code that translates SAM templates into AWS CloudFormation stacks and lots of example applications.
56In the words of SAM developers:
57
58> SAM Translator is the Python code that deploys SAM templates via AWS CloudFormation. Source code is high quality (95% unit test coverage),
59with tons of tests to ensure your changes don't break compatibility. Change the code, run the tests, and if they pass, you should be good to go!
60Clone it and run `make pr`!
61
62## Contribute to SAM
63
64We love our contributors ❤️ We have over 100 contributors who have built various parts of the product.
65Read this [testimonial from @ndobryanskyy](https://www.lohika.com/aws-sam-my-exciting-first-open-source-experience/) to learn
66more about what it was like contributing to SAM.
67
68Depending on your interest and skill, you can help build the different parts of the SAM project;
69
70**Enhance the SAM Specification**
71
72Make pull requests, report bugs, and share ideas to improve the full SAM template specification.
73Source code is located on Github at [awslabs/serverless-application-model](https://github.com/awslabs/serverless-application-model).
74Read the [SAM Specification Contributing Guide](https://github.com/awslabs/serverless-application-model/blob/master/CONTRIBUTING.md)
75to get started.
76
77**Strengthen SAM CLI**
78
79Add new commands or enhance existing ones, report bugs, or request new features for the SAM CLI.
80Source code is located on Github at [awslabs/aws-sam-cli](https://github.com/awslabs/aws-sam-cli). Read the [SAM CLI Contributing Guide](https://github.com/awslabs/aws-sam-cli/blob/develop/CONTRIBUTING.md) to
81get started.
82
83**Update SAM Developer Guide**
84
85[SAM Developer Guide](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/index.html) provides comprehensive getting started guide and reference documentation.
86Source code is located on Github at [awsdocs/aws-sam-developer-guide](https://github.com/awsdocs/aws-sam-developer-guide).
87Read the [SAM Documentation Contribution Guide](https://github.com/awsdocs/aws-sam-developer-guide/blob/master/CONTRIBUTING.md) to get
88started.
89
90### Join the SAM Community on Slack
91[Join the SAM developers channel (#samdev)](https://join.slack.com/t/awsdevelopers/shared_invite/zt-idww18e8-Z1kXhI7GNuDewkweCF3YjA) on Slack to collaborate with fellow community members and the AWS SAM team.
92
93
94
95
){kind=link}
){kind=link}
){kind=link}
