CloudFormation / Client / execute_change_set

execute_change_set#

CloudFormation.Client.execute_change_set(**kwargs)#

Updates a stack using the input information that was provided when the specified change set was created. After the call successfully completes, CloudFormation starts updating the stack. Use the DescribeStacks action to view the status of the update.

When you execute a change set, CloudFormation deletes all other change sets associated with the stack because they aren’t valid for the updated stack.

If a stack policy is associated with the stack, CloudFormation enforces the policy during the update. You can’t specify a temporary stack policy that overrides the current policy.

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

See also: AWS API Documentation

Request Syntax

response = client.execute_change_set(
    ChangeSetName='string',
    StackName='string',
    ClientRequestToken='string',
    DisableRollback=True|False,
    RetainExceptOnCreate=True|False
)
Parameters:

  • ChangeSetName (string) –

    [REQUIRED]

    The name or Amazon Resource Name (ARN) of the change set that you want use to update the specified stack.

  • StackName (string) – If you specified the name of a change set, specify the stack name or Amazon Resource Name (ARN) that’s associated with the change set you want to execute.

  • ClientRequestToken (string) – A unique identifier for this ExecuteChangeSet request. Specify this token if you plan to retry requests so that CloudFormation knows that you’re not attempting to execute a change set to update a stack with the same name. You might retry ExecuteChangeSet requests to ensure that CloudFormation successfully received them.

  • DisableRollback (boolean) –

    Preserves the state of previously provisioned resources when an operation fails. This parameter can’t be specified when the OnStackFailure parameter to the CreateChangeSet API operation was specified.

    • True - if the stack creation fails, do nothing. This is equivalent to specifying DO_NOTHING for the OnStackFailure parameter to the CreateChangeSet API operation.

    • False - if the stack creation fails, roll back the stack. This is equivalent to specifying ROLLBACK for the OnStackFailure parameter to the CreateChangeSet API operation.

    Default: True

  • RetainExceptOnCreate (boolean) – This deletion policy deletes newly created resources, but retains existing resources, when a stack operation is rolled back. This ensures new, empty, and unused resources are deleted, while critical resources and their data are retained. RetainExceptOnCreate can be specified for any resource that supports the DeletionPolicy attribute.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

    The output for the ExecuteChangeSet action.

Exceptions

  • CloudFormation.Client.exceptions.InvalidChangeSetStatusException

  • CloudFormation.Client.exceptions.ChangeSetNotFoundException

  • CloudFormation.Client.exceptions.InsufficientCapabilitiesException

  • CloudFormation.Client.exceptions.TokenAlreadyExistsException