CreateChangeSetRequest
The input for the CreateChangeSet action.
Types
Properties
In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to create the stack.
The name of the change set. The name must be unique among all change sets that are associated with the specified stack.
The type of change set operation. To create a change set for a new stack, specify CREATE
. To create a change set for an existing stack, specify UPDATE
. To create a change set for an import operation, specify IMPORT
.
A unique identifier for this CreateChangeSet
request. Specify this token if you plan to retry requests so that CloudFormation knows that you're not attempting to create another change set with the same name. You might retry CreateChangeSet
requests to ensure that CloudFormation successfully received them.
A description to help you identify this change set.
Indicates if the change set imports resources that already exist.
Creates a change set for the all nested stacks specified in the template. The default behavior of this action is set to False
. To include nested sets in a change set, specify True
.
The Amazon Resource Names (ARNs) of Amazon SNS topics that CloudFormation associates with the stack. To remove all associated notification topics, specify an empty list.
Determines what action will be taken if stack creation fails. If this parameter is specified, the DisableRollback
parameter to the ExecuteChangeSet API operation must not be specified. This must be one of these values:
A list of Parameter
structures that specify input parameters for the change set. For more information, see the Parameter data type.
The resources to import into your stack.
The template resource types that you have permissions to work with if you execute this change set, such as AWS::EC2::Instance
, AWS::EC2::*
, or Custom::MyCustomInstance
.
The Amazon Resource Name (ARN) of an IAM role that CloudFormation assumes when executing the change set. CloudFormation uses the role's credentials to make calls on your behalf. CloudFormation uses this role for all future operations on the stack. Provided that users have permission to operate on the stack, CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least permission.
The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.
A structure that contains the body of the revised template, with a minimum length of 1 byte and a maximum length of 51,200 bytes. CloudFormation generates the change set by comparing this template with the template of the stack that you specified.
The URL of the file that contains the revised template. The URL must point to a template (max size: 1 MB) that's located in an Amazon S3 bucket or a Systems Manager document. CloudFormation generates the change set by comparing this template with the stack that you specified. The location for an Amazon S3 bucket must start with https://
.
Whether to reuse the template that's associated with the stack to create the change set.