index.md

AWS Serverless Application Model Developer Guide

---

Copyright © 2020 Amazon Web Services, Inc. and/or its affiliates. All rights reserved.

---

Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be affiliated with, connected to, or sponsored by Amazon.

---

Contents

• What Is the AWS Serverless Application Model (AWS SAM)?
• Getting Started with AWS SAM
  • Installing the AWS SAM CLI
    • Installing the AWS SAM CLI on Linux
    • Installing the AWS SAM CLI on Windows
    • Installing the AWS SAM CLI on macOS
  • Setting Up AWS Credentials
  • Tutorial: Deploying a Hello World Application
• AWS Serverless Application Model (AWS SAM) Specification
  • AWS SAM Template Anatomy
    • Globals Section of the Template
  • AWS SAM Resource and Property Reference
    • AWS::Serverless::Api
      • ApiAuth
        • ApiUsagePlan
        • CognitoAuthorizer
          • CognitoAuthorizationIdentity
        • LambdaRequestAuthorizer
          • LambdaRequestAuthorizationIdentity
        • LambdaTokenAuthorizer
          • LambdaTokenAuthorizationIdentity
        • ResourcePolicyStatement
      • ApiDefinition
      • CorsConfiguration
      • DomainConfiguration
        • Route53Configuration
    • AWS::Serverless::Application
      • ApplicationLocationObject
    • AWS::Serverless::Function
      • DeadLetterQueue
      • DeploymentPreference
        • Hooks
      • EventInvokeConfiguration
        • EventInvokeDestinationConfiguration
          • OnFailure
          • OnSuccess
      • EventSource
        • AlexaSkill
        • Api
          • ApiFunctionAuth
            • ResourcePolicyStatement
          • RequestModel
          • RequestParameter
        • CloudWatchEvent
        • CloudWatchLogs
        • Cognito
        • DynamoDB
        • EventBridgeRule
        • HttpApi
          • HttpApiFunctionAuth
        • IoTRule
        • Kinesis
        • S3
        • Schedule
        • SNS
          • SqsSubscriptionObject
        • SQS
      • FunctionCode
    • AWS::Serverless::HttpApi
      • HttpApiAuth
        • OAuth2Authorizer
      • HttpApiCorsConfiguration
      • HttpApiDefinition
      • HttpApiDomainConfiguration
        • Route53Configuration
    • AWS::Serverless::LayerVersion
      • LayerContent
    • AWS::Serverless::SimpleTable
      • PrimaryKeyObject
    • AWS::Serverless::StateMachine
      • EventSource
        • EventBridgeRule
        • Schedule
        • Api
          • ApiStateMachineAuth
            • ResourcePolicyStatement
        • CloudWatchEvent
  • Resource Attributes
  • Intrinsic Functions
  • Generated AWS CloudFormation Resources
    • AWS CloudFormation Resources Generated When AWS::Serverless::Api Is Specified
    • AWS CloudFormation Resources Generated When AWS::Serverless::Function Is Specified
    • AWS CloudFormation Resources Generated When AWS::Serverless::HttpApi Is Specified
  • API Gateway Extensions
• Authoring Serverless Applications
  • Validating AWS SAM Template Files
  • Working with Layers
  • Using Nested Applications
  • Controlling Access to API Gateway APIs
  • Orchestrating AWS Resources with AWS Step Functions
• Building Serverless Applications
  • Building Applications
  • Building Layers
  • Building Custom Runtimes
• Testing and Debugging Serverless Applications
  • Invoking Functions Locally
  • Running API Gateway Locally
  • Integrating with Automated Tests
  • Generating Sample Event Payloads
  • Step-Through Debugging Lambda Functions Locally
    • Step-Through Debugging Node.js Functions Locally
    • Step-Through Debugging Python Functions Locally
    • Step-Through Debugging Golang Functions Locally
  • Passing Additional Runtime Debug Arguments
• Deploying Serverless Applications
  • Deploying Serverless Applications Gradually
• Monitoring Serverless Applications
  • Working with Logs
• Publishing Serverless Applications Using the AWS SAM CLI
  • AWS SAM Template Metadata Section Properties
• Example Serverless Applications
  • Process DynamoDB Events
  • Process Amazon S3 Events
• AWS SAM Reference
  • AWS SAM CLI Command Reference
    • sam build
    • sam deploy
    • sam init
    • sam local generate-event
    • sam local invoke
    • sam local start-api
    • sam local start-lambda
    • sam logs
    • sam package
    • sam publish
    • sam validate
  • AWS SAM CLI Config
  • AWS SAM Policy Templates
    • Policy Template List
  • Telemetry in the AWS SAM CLI
  • Important Notes
• Document History for AWS Serverless Application Model