AWS Toolkit for VS Code
User Guide

Deploying a Serverless Application with the AWS Toolkit for Visual Studio Code

This example shows how to deploy the serverless application that was created in the previous topic (Creating a Serverless Application) to AWS using the AWS Toolkit for Visual Studio Code.

Prerequisites

  • If you haven't already done so, satisfy the prerequisites specified in Installing the Toolkit for VS Code.

  • Be sure to choose a globally unique Amazon S3 bucket name.

  • Ensure that the credentials you configured in Establishing Credentials include the appropriate read/write access to the following services: Amazon S3, AWS CloudFormation, AWS Lambda, and Amazon API Gateway.

Deploy a Serverless Application

  1. To open the Command Palette, choose View, Command Palette, and then enter AWS.

  2. Choose AWS: Deploy SAM Application.

    
            Command to deploy a serverless application.
  3. Choose the template.yaml file to use for the deployment.

    
            Choose a serverless application template.
  4. Choose the AWS Region to deploy to.

    
            Choose the serverless application Region.
  5. Enter the name of an Amazon S3 bucket this deployment can use. The bucket must be in the Region you're deploying to.

    Warning

    The Amazon S3 bucket name must be globally unique across all existing bucket names in Amazon S3. Therefore, you should add a unique identifier to the name given in the following example (or choose a different name).

    
            Choose the serverless application bucket.
  6. Enter a name for the deployed stack, either a new stack name or an existing stack name.

    
            Enter a serverless application stack name.
  7. Verify the success of the deployment on the OUTPUT tab of VS Code.

    
            Screenshot of the output from deploying a serverless application.

    If an error occurs, a message pops up in the lower-right that is similar to the following:

    
            Screenshot of an error popup while deploying a serverless application.

    If this happens, check the text in the OUTPUT tab for details. The following is an example of error details.

    Error with child process: Unable to upload artifact HelloWorldFunction referenced by CodeUri parameter of HelloWorldFunction resource. S3 Bucket does not exist. Execute the command to create a new bucket aws s3 mb s3://pbart-my-sam-app-bucket An error occurred while deploying a SAM Application. Check the logs for more information by running the "View AWS Toolkit Logs" command from the Command Palette.

    In this example, the error occurred because the Amazon S3 bucket did not exist.

When the deployment is complete, you'll see your application listed in the AWS Explorer. To learn how to invoke the Lambda function that was created as part of the application, see Interacting with Remote Lambda Functions.