CloudFormation / Client / create_change_set

create_change_set#

CloudFormation.Client.create_change_set(**kwargs)#

Creates a list of changes that will be applied to a stack so that you can review the changes before executing them. You can create a change set for a stack that doesn’t exist or an existing stack. If you create a change set for a stack that doesn’t exist, the change set shows all of the resources that CloudFormation will create. If you create a change set for an existing stack, CloudFormation compares the stack’s information with the information that you submit in the change set and lists the differences. Use change sets to understand which resources CloudFormation will create or change, and how it will change resources in an existing stack, before you create or update a stack.

To create a change set for a stack that doesn’t exist, for the ChangeSetType parameter, specify CREATE. To create a change set for an existing stack, specify UPDATE for the ChangeSetType parameter. To create a change set for an import operation, specify IMPORT for the ChangeSetType parameter. After the CreateChangeSet call successfully completes, CloudFormation starts creating the change set. To check the status of the change set or to review it, use the DescribeChangeSet action.

When you are satisfied with the changes the change set will make, execute the change set by using the ExecuteChangeSet action. CloudFormation doesn’t make changes until you execute the change set.

To create a change set for the entire stack hierarchy, set IncludeNestedStacks to True.

See also: AWS API Documentation

Request Syntax

response = client.create_change_set(
    StackName='string',
    TemplateBody='string',
    TemplateURL='string',
    UsePreviousTemplate=True|False,
    Parameters=[
        {
            'ParameterKey': 'string',
            'ParameterValue': 'string',
            'UsePreviousValue': True|False,
            'ResolvedValue': 'string'
        },
    ],
    Capabilities=[
        'CAPABILITY_IAM'|'CAPABILITY_NAMED_IAM'|'CAPABILITY_AUTO_EXPAND',
    ],
    ResourceTypes=[
        'string',
    ],
    RoleARN='string',
    RollbackConfiguration={
        'RollbackTriggers': [
            {
                'Arn': 'string',
                'Type': 'string'
            },
        ],
        'MonitoringTimeInMinutes': 123
    },
    NotificationARNs=[
        'string',
    ],
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    ChangeSetName='string',
    ClientToken='string',
    Description='string',
    ChangeSetType='CREATE'|'UPDATE'|'IMPORT',
    ResourcesToImport=[
        {
            'ResourceType': 'string',
            'LogicalResourceId': 'string',
            'ResourceIdentifier': {
                'string': 'string'
            }
        },
    ],
    IncludeNestedStacks=True|False
)
Parameters:

  • StackName (string) –

    [REQUIRED]

    The name or the unique ID of the stack for which you are creating a change set. CloudFormation generates the change set by comparing this stack’s information with the information that you submit, such as a modified template or different parameter input values.

  • TemplateBody (string) –

    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.

    Conditional: You must specify only TemplateBody or TemplateURL.

  • TemplateURL (string) –

    The location of the file that contains the revised template. The URL must point to a template (max size: 460,800 bytes) 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.

    Conditional: You must specify only TemplateBody or TemplateURL.

  • UsePreviousTemplate (boolean) – Whether to reuse the template that’s associated with the stack to create the change set.

  • Parameters (list) –

    A list of Parameter structures that specify input parameters for the change set. For more information, see the Parameter data type.

    • (dict) –

      The Parameter data type.

      • ParameterKey (string) –

        The key associated with the parameter. If you don’t specify a key and value for a particular parameter, CloudFormation uses the default value that’s specified in your template.

      • ParameterValue (string) –

        The input value associated with the parameter.

      • UsePreviousValue (boolean) –

        During a stack update, use the existing parameter value that the stack is using for a given parameter key. If you specify true, do not specify a parameter value.

      • ResolvedValue (string) –

        Read-only. The value that corresponds to a SSM parameter key. This field is returned only for `SSM <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/parameters-section-structure.html#aws-ssm-parameter-types>`__parameter types in the template.

  • Capabilities (list) –

    In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order for CloudFormation to create the stack.

    • CAPABILITY_IAM and CAPABILITY_NAMED_IAM Some stack templates might include resources that can affect permissions in your Amazon Web Services account; for example, by creating new Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge this by specifying one of these capabilities. The following IAM resources require you to specify either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.

      • If you have IAM resources, you can specify either capability.

      • If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.

      • If you don’t specify either of these capabilities, CloudFormation returns an InsufficientCapabilities error.

    If your stack template contains these resources, we suggest that you review all permissions associated with them and edit their permissions if necessary.

    For more information, see Acknowledging IAM resources in CloudFormation templates.

    • CAPABILITY_AUTO_EXPAND Some template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually creating the stack. If your stack template contains one or more macros, and you choose to create a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.

    Note

    This capacity doesn’t apply to creating change sets, and specifying it when creating change sets has no effect. If you want to create a stack from a stack template that contains macros and nested stacks, you must create or update the stack directly from the template using the CreateStack or UpdateStack action, and specifying this capability.

    For more information about macros, see Using CloudFormation macros to perform custom processing on templates.

    • (string) –

  • ResourceTypes (list) –

    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.

    If the list of resource types doesn’t include a resource type that you’re updating, the stack update fails. By default, CloudFormation grants permissions to all resource types. Identity and Access Management (IAM) uses this parameter for condition keys in IAM policies for CloudFormation. For more information, see Controlling access with Identity and Access Management in the CloudFormation User Guide.

    • (string) –

  • RoleARN (string) –

    The Amazon Resource Name (ARN) of an Identity and Access Management (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.

    If you don’t specify a value, CloudFormation uses the role that was previously associated with the stack. If no role is available, CloudFormation uses a temporary session that is generated from your user credentials.

  • RollbackConfiguration (dict) –

    The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.

    • RollbackTriggers (list) –

      The triggers to monitor during stack creation or update actions.

      By default, CloudFormation saves the rollback triggers specified for a stack and applies them to any subsequent update operations for the stack, unless you specify otherwise. If you do specify rollback triggers for this parameter, those triggers replace any list of triggers previously specified for the stack. This means:

      • To use the rollback triggers previously specified for this stack, if any, don’t specify this parameter.

      • To specify new or updated rollback triggers, you must specify all the triggers that you want used for this stack, even triggers you’ve specified before (for example, when creating the stack or during a previous stack update). Any triggers that you don’t include in the updated list of triggers are no longer applied to the stack.

      • To remove all currently specified triggers, specify an empty list for this parameter.

      If a specified trigger is missing, the entire stack operation fails and is rolled back.

      • (dict) –

        A rollback trigger CloudFormation monitors during creation and updating of stacks. If any of the alarms you specify goes to ALARM state during the stack operation or within the specified monitoring period afterwards, CloudFormation rolls back the entire stack operation.

        • Arn (string) – [REQUIRED]

          The Amazon Resource Name (ARN) of the rollback trigger.

          If a specified trigger is missing, the entire stack operation fails and is rolled back.

        • Type (string) – [REQUIRED]

          The resource type of the rollback trigger. Specify either AWS::CloudWatch::Alarm or AWS::CloudWatch::CompositeAlarm resource types.

    • MonitoringTimeInMinutes (integer) –

      The amount of time, in minutes, during which CloudFormation should monitor all the rollback triggers after the stack creation or update operation deploys all necessary resources.

      The default is 0 minutes.

      If you specify a monitoring period but don’t specify any rollback triggers, CloudFormation still waits the specified period of time before cleaning up old resources after update operations. You can use this monitoring period to perform any manual stack validation desired, and manually cancel the stack creation or update (using CancelUpdateStack, for example) as necessary.

      If you specify 0 for this parameter, CloudFormation still monitors the specified rollback triggers during stack creation and update operations. Then, for update operations, it begins disposing of old resources immediately once the operation completes.

  • NotificationARNs (list) –

    The Amazon Resource Names (ARNs) of Amazon Simple Notification Service (Amazon SNS) topics that CloudFormation associates with the stack. To remove all associated notification topics, specify an empty list.

    • (string) –

  • Tags (list) –

    Key-value pairs to associate with this stack. CloudFormation also propagates these tags to resources in the stack. You can specify a maximum of 50 tags.

    • (dict) –

      The Tag type enables you to specify a key-value pair that can be used to store information about an CloudFormation stack.

      • Key (string) – [REQUIRED]

        Required. A string used to identify this tag. You can specify a maximum of 128 characters for a tag key. Tags owned by Amazon Web Services (Amazon Web Services) have the reserved prefix: aws:.

      • Value (string) – [REQUIRED]

        Required. A string containing the value for this tag. You can specify a maximum of 256 characters for a tag value.

  • ChangeSetName (string) –

    [REQUIRED]

    The name of the change set. The name must be unique among all change sets that are associated with the specified stack.

    A change set name can contain only alphanumeric, case sensitive characters, and hyphens. It must start with an alphabetical character and can’t exceed 128 characters.

  • ClientToken (string) – 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.

  • Description (string) – A description to help you identify this change set.

  • ChangeSetType (string) –

    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.

    If you create a change set for a new stack, CloudFormation creates a stack with a unique stack ID, but no template or resources. The stack will be in the `REVIEW_IN_PROGRESS <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-describing-stacks.html#d0e11995>`__state until you execute the change set.

    By default, CloudFormation specifies UPDATE. You can’t use the UPDATE type to create a change set for a new stack or the CREATE type to create a change set for an existing stack.

  • ResourcesToImport (list) –

    The resources to import into your stack.

    • (dict) –

      Describes the target resource of an import operation.

      • ResourceType (string) – [REQUIRED]

        The type of resource to import into your stack, such as AWS::S3::Bucket. For a list of supported resource types, see Resources that support import operations in the CloudFormation User Guide.

      • LogicalResourceId (string) – [REQUIRED]

        The logical ID of the target resource as specified in the template.

      • ResourceIdentifier (dict) – [REQUIRED]

        A key-value pair that identifies the target resource. The key is an identifier property (for example, BucketName for AWS::S3::Bucket resources) and the value is the actual property value (for example, MyS3Bucket).

        • (string) –

          • (string) –

  • IncludeNestedStacks (boolean) – 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.

Return type:

dict

Returns:

Response Syntax

{
    'Id': 'string',
    'StackId': 'string'
}

Response Structure

  • (dict) –

    The output for the CreateChangeSet action.

    • Id (string) –

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

    • StackId (string) –

      The unique ID of the stack.

Exceptions

  • CloudFormation.Client.exceptions.AlreadyExistsException

  • CloudFormation.Client.exceptions.InsufficientCapabilitiesException

  • CloudFormation.Client.exceptions.LimitExceededException