sam deploy

Set the SAM_CLI_POLL_DELAY environment variable with a value of seconds in your shell to configure how often the Amazon SAM CLI checks the Amazon CloudFormation stack state, which is useful when seeing throttling from Amazon CloudFormation. This env variable is used for polling describe_stack API calls, which are made while running sam deploy.

The following is an example of this variable:

$ SAM_CLI_POLL_DELAY=5 sam deploy

A list of capabilities that you must specify to allow Amazon CloudFormation to create certain stacks. Some stack templates might include resources that affect permissions in your Amazon Web Services account, for example, by creating new Amazon Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge their capabilities by specifying this option. The only valid values are CAPABILITY_IAM and CAPABILITY_NAMED_IAM. If you have IAM resources, then you can specify either capability. If you have IAM resources with custom names, then you must specify CAPABILITY_NAMED_IAM. If you don't specify this option, then the operation returns an InsufficientCapabilities error.

When you deploy an application that contains nested applications, you must use CAPABILITY_AUTO_EXPAND to acknowledge the application contains nested applications. For more information, see Deploying nested applications.

The environment name specifying the default parameter values in the configuration file to use. The default value is default. For more information about configuration files, see Amazon SAM CLI configuration file.

The path and file name of the configuration file containing default parameter values to use. The default value is samconfig.toml in the root of the project directory. For more information about configuration files, see Amazon SAM CLI configuration file.

Prompt to confirm whether the Amazon SAM CLI deploys the computed changeset.

Turn on debug logging to print the debug message that the Amazon SAM CLI generates and to display timestamps.

Specify whether to roll back your Amazon CloudFormation stack if an error occurs during a deployment. By default, if there's an error during a deployment, your Amazon CloudFormation stack rolls back to the last stable state. If you specify --disable-rollback and an error occurs during a deployment, then resources that were created or updated before the error occurred aren't rolled back.

Specify whether to return a non-zero exit code if there are no changes to make to the stack. The default behavior is to return a non-zero exit code.

Specify this option to upload artifacts even if they match existing artifacts in the Amazon S3 bucket. Matching artifacts are overwritten.

Specify this option to have the Amazon SAM CLI use prompts to guide you through the deployment.

Show this message and exit.

A mapping of functions to their Amazon ECR repository URI. Reference functions by their logical ID. The following is an example:

$ sam deploy --image-repositories Function1=123456789012.dkr.ecr.us-east-1.amazonaws.com/my-repo

You can specify this option multiple times in a single command.

The name of the Amazon ECR repository where this command uploads your function's image. This option is required for functions declared with the Image package type.

The ID of an Amazon Key Management Service (Amazon KMS) key used to encrypt artifacts that are at rest in the Amazon S3 bucket. If you don't specify this option, then Amazon SAM uses Amazon S3-managed encryption keys.

A map of metadata to attach to all artifacts that are referenced in your template.

Indicates whether to apply the changeset. Specify this option if you want to view your stack changes before applying the changeset. This command creates an Amazon CloudFormation changeset and then exits without applying the changeset. To apply the changeset, run the same command without this option.

Do not display a progress bar when uploading artifacts to Amazon S3.

A list of Amazon Simple Notification Service (Amazon SNS) topic ARNs that Amazon CloudFormation associates with the stack.

Specify the action to take when a stack fails to create.

The following options are available:

The default behavior is ROLLBACK.

A string that contains Amazon CloudFormation parameter overrides encoded as key-value pairs. Each override uses the format ParameterKey=name,ParameterValue=value. Multiple overrides are separated by spaces. Here are two examples:

$ sam deploy --parameter-overrides ParameterKey=value1,ParameterValue=value2

$ sam deploy --parameter-overrides ParameterKey=value1,ParameterValue=value2 ParameterKey=hello,ParameterValue=world ParameterKey=apple,ParameterValue=banana

The specific profile from your credential file that gets Amazon credentials.

The Amazon Web Services Region to deploy to. For example, us-east-1.

Automatically create Amazon ECR repositories to use for packaging and deploying for non-guided deployments. This option applies only to functions and layers with PackageType: Image specified. If you specify the --guided option, then the Amazon SAM CLI ignores --resolve-image-repos.

Automatically create an Amazon S3 bucket to use for packaging and deploying for non-guided deployments. If you specify the --guided option, then the Amazon SAM CLI ignores --resolve-s3. If you specify both the --s3-bucket and --resolve-s3 options, then an error occurs.

The Amazon Resource Name (ARN) of an IAM role that Amazon CloudFormation assumes when applying the changeset.

The name of the Amazon S3 bucket where this command uploads your Amazon CloudFormation template. If your template is larger than 51,200 bytes, then either the --s3-bucket option or the --resolve-s3 option is required. If you specify both the --s3-bucket and --resolve-s3 options, then an error occurs.

The prefix added to the names of the artifacts that are uploaded to the Amazon S3 bucket. The prefix name is a path name (folder name) for the Amazon S3 bucket.

Save the parameters that you provide at the command line to the Amazon SAM configuration file.

The list of signing profiles to sign your deployment packages with. This option takes a list of key-value pairs, where the key is the name of the function or layer to sign, and the value is the signing profile, with an optional profile owner delimited with :. For example, FunctionNameToSign=SigningProfileName1 LayerNameToSign=SigningProfileName2:SigningProfileOwner.

(Required) The name of the Amazon CloudFormation stack that you're deploying to. If you specify an existing stack, then the command updates the stack. If you specify a new stack, then the command creates it.

A list of tags to associate with the stack that is created or updated. Amazon CloudFormation also propagates these tags to resources in the stack that support it.

The path and file name where your Amazon SAM template is located.

Output JSON for the Amazon CloudFormation template. The default output is YAML.