Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . serverlessrepo ]

create-cloud-formation-change-set

Description

Creates an AWS CloudFormation change set for the given application.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  create-cloud-formation-change-set
--application-id <value>
[--capabilities <value>]
[--change-set-name <value>]
[--client-token <value>]
[--description <value>]
[--notification-arns <value>]
[--parameter-overrides <value>]
[--resource-types <value>]
[--rollback-configuration <value>]
[--semantic-version <value>]
--stack-name <value>
[--tags <value>]
[--template-id <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--application-id (string)

The Amazon Resource Name (ARN) of the application.

--capabilities (list)

A list of values that you must specify before you can deploy certain applications. Some applications might include resources that can affect permissions in your AWS account, for example, by creating new AWS Identity and Access Management (IAM) users. For those applications, you must explicitly acknowledge their capabilities by specifying this parameter.

The only valid values are CAPABILITY_IAM, CAPABILITY_NAMED_IAM, and CAPABILITY_RESOURCE_POLICY.

The following resources require you to specify CAPABILITY_IAM or CAPABILITY_NAMED_IAM: AWS::IAM::Group , AWS::IAM::InstanceProfile , AWS::IAM::Policy , and AWS::IAM::Role . If the application contains IAM resources, you can specify either CAPABILITY_IAM or CAPABILITY_NAMED_IAM. If the application contains IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.

The following resources require you to specify CAPABILITY_RESOURCE_POLICY: AWS::Lambda::Permission , AWS::IAM:Policy , AWS::ApplicationAutoScaling::ScalingPolicy , AWS::S3::BucketPolicy , AWS::SQS::QueuePolicy , and AWS::SNS:TopicPolicy .

If your application template contains any of the above resources, we recommend that you review all permissions associated with the application before deploying. If you don't specify this parameter for an application that requires capabilities, the call will fail.

Valid values: CAPABILITY_IAM | CAPABILITY_NAMED_IAM | CAPABILITY_RESOURCE_POLICY

Syntax:

"string" "string" ...

--change-set-name (string)

This property corresponds to the parameter of the same name for the AWS CloudFormation `CreateChangeSet <https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/CreateChangeSet>`__ API.

--client-token (string)

This property corresponds to the parameter of the same name for the AWS CloudFormation `CreateChangeSet <https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/CreateChangeSet>`__ API.

--description (string)

This property corresponds to the parameter of the same name for the AWS CloudFormation `CreateChangeSet <https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/CreateChangeSet>`__ API.

--notification-arns (list)

This property corresponds to the parameter of the same name for the AWS CloudFormation `CreateChangeSet <https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/CreateChangeSet>`__ API.

Syntax:

"string" "string" ...

--parameter-overrides (list)

A list of parameter values for the parameters of the application.

Shorthand Syntax:

Name=string,Value=string ...

JSON Syntax:

[
  {
    "Name": "string",
    "Value": "string"
  }
  ...
]

--resource-types (list)

This property corresponds to the parameter of the same name for the AWS CloudFormation `CreateChangeSet <https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/CreateChangeSet>`__ API.

Syntax:

"string" "string" ...

--rollback-configuration (structure)

This property corresponds to the parameter of the same name for the AWS CloudFormation `CreateChangeSet <https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/CreateChangeSet>`__ API.

Shorthand Syntax:

MonitoringTimeInMinutes=integer,RollbackTriggers=[{Arn=string,Type=string},{Arn=string,Type=string}]

JSON Syntax:

{
  "MonitoringTimeInMinutes": integer,
  "RollbackTriggers": [
    {
      "Arn": "string",
      "Type": "string"
    }
    ...
  ]
}

--semantic-version (string)

The semantic version of the application:

--stack-name (string)

This property corresponds to the parameter of the same name for the AWS CloudFormation `CreateChangeSet <https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/CreateChangeSet>`__ API.

--tags (list)

This property corresponds to the parameter of the same name for the AWS CloudFormation `CreateChangeSet <https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/CreateChangeSet>`__ API.

Shorthand Syntax:

Key=string,Value=string ...

JSON Syntax:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--template-id (string)

The UUID returned by CreateCloudFormationTemplate.

Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

ApplicationId -> (string)

The application Amazon Resource Name (ARN).

ChangeSetId -> (string)

The Amazon Resource Name (ARN) of the change set.

Length constraints: Minimum length of 1.

Pattern: ARN:[-a-zA-Z0-9:/]*

SemanticVersion -> (string)

The semantic version of the application:

StackId -> (string)

The unique ID of the stack.