Publishing serverless applications using the AWS SAM CLI - AWS Serverless Application Model
PrerequisitesPublishing a new applicationPublishing a new version of an existing applicationAdditional topics

Publishing serverless applications using the AWS SAM CLI

You can use the AWS SAM CLI to publish your application to the AWS Serverless Application Repository to make it available for others to find and deploy.

The application that you want to publish must be one that you've defined using AWS SAM. You also need to have tested it locally and/or in the AWS Cloud. The application's deployment package and AWS SAM template are the inputs to the following procedure steps.

The following instructions either create a new application, create a new version of an existing application, or update the metadata of an existing application. This depends on whether the application already exists in the AWS Serverless Application Repository, and whether any application metadata is changing. For more information about application metadata that's used to publish applications, see AWS SAM template Metadata section properties.

Prerequisites

Before you publish an application to the AWS Serverless Application Repository, you need the following:

  • A valid AWS account with an IAM user that has administrator permissions. See Set Up an AWS Account.

  • Version 1.16.77 or later of the AWS CLI installed. See Installing the AWS Command Line Interface. If you have the AWS CLI installed, you can get the version by running the following command: 

    aws --version

  • The AWS SAM CLI (command line interface) installed. See Installing the AWS SAM CLI. You can determine whether the AWS SAM CLI is installed by running the following command: 

    sam --version

  • A valid AWS Serverless Application Model (AWS SAM) template.

  • Your application code and dependencies referenced by the AWS SAM template.

  • A semantic version for your application (required to share your application publicly). This value can be as simple as 1.0.

  • A URL that points to your application's source code.

  • A README.md file. This file should describe how customers can use your application, and how to configure it before deploying it in their own AWS accounts.

  • A LICENSE.txt file (required to share your application publicly).

  • A valid Amazon S3 bucket policy that grants the service read permissions for artifacts uploaded to Amazon S3 when you packaged your application. To do this, follow these steps:

    1. Open the Amazon S3 console at https://console.aws.amazon.com/s3/.

    2. Choose the Amazon S3 bucket that you used to package your application.

    3. Choose the Permissions tab.

    4. Choose the Bucket Policy button.

    5. Paste the following policy statement into the Bucket policy editor. Make sure to substitute your bucket name in the Resource element, and your AWS account ID in the Condition element. The expression in the Condition element ensure AWS Serverless Application Repository only has permission to access applications from the specified AWS account. For more information about policy statements, see IAM JSON policy elements reference in the IAM User Guide. 

      {
    "Version": "2012-10-17",
    "Statement": [
        {
            "Effect": "Allow",
            "Principal": {
                "Service":  "serverlessrepo.amazonaws.com"
            },
            "Action": "s3:GetObject",
            "Resource": "arn:aws:s3:::<your-bucket-name>/*",
            "Condition" : {
                "StringEquals": {
                    "aws:SourceAccount": "123456789012"
                }
            }
        }
    ]
}

    6. Choose the Save button.

Publishing a new application

Step 1: Add a Metadata section to the AWS SAM template

First add a Metadata section to your AWS SAM template. Provide the application information to be published to the AWS Serverless Application Repository.

The following is an example Metadata section: 

Metadata:
  AWS::ServerlessRepo::Application:
    Name: my-app
    Description: hello world
    Author: user1
    SpdxLicenseId: Apache-2.0
    LicenseUrl: LICENSE.txt
    ReadmeUrl: README.md
    Labels: ['tests']
    HomePageUrl: https://github.com/user1/my-app-project
    SemanticVersion: 0.0.1
    SourceCodeUrl: https://github.com/user1/my-app-project

Resources:
  HelloWorldFunction:
    Type: AWS::Lambda::Function
      Properties:
        ...
        CodeUri: source-code1
        ...

For more information about the properties of the Metadata section in the AWS SAM template, see AWS SAM template Metadata section properties.

Step 2: Package the application

Execute the following AWS SAM CLI command: 

sam package \
    --template-file template.yaml \
    --output-template-file packaged.yaml \
    --s3-bucket <your-bucket-name>

The command uploads the application artifacts to Amazon S3 and outputs a new template file called packaged.yaml. You use this file in the next step to publish the application to the AWS Serverless Application Repository. The packaged.yaml template file is similar to the original template file (template.yaml), but has a key difference—the CodeUri, LicenseUrl, and ReadmeUrl properties point to the Amazon S3 bucket and objects that contain the respective artifacts.

The following snippet from an example packaged.yaml template file shows the CodeUri property: 

MySampleFunction:
    Type: AWS::Serverless::Function
    Properties:
      CodeUri: s3://bucketname/fbd77a3647a4f47a352fcObjectGUID

...

Step 3: Publish the application

Execute the following AWS SAM CLI command: 

sam publish \
    --template packaged.yaml \
    --region us-east-1

The output of the sam publish command includes a link to the AWS Serverless Application Repository directly to your application. You can also go to the AWS Serverless Application Repository landing page directly and search for your application.

Your application is set to private by default, so it isn't visible to other AWS accounts. In order to share your application with others, you must either make it public or grant permission to a specific list of AWS accounts. For information on sharing your application by using the AWS CLI, see Using Resource-based Policies for the AWS Serverless Application Repository. For information on sharing your application using the console, see Sharing an Application Through the Console.

Publishing a new version of an existing application

After you've published an application to the AWS Serverless Application Repository, you might want to publish a new version of it. For example, you might have changed your Lambda function code or added a new component to your application architecture.

To update an application that you've previously published, you publish the application using the same process as above. You provide the same application name that you originally published it with, but with a new SemanticVersion value. You also provide the application name and SematicVersion number in the Metadata section of the AWS SAM template file.

For example, if you published an application with the name SampleApp and SematicVersion 1.0.0, to update that application, the AWS SAM template must have application name SampleApp, and the SematicVersion can be 1.0.1 (or anything different from 1.0.0).

Additional topics