Skip to content

CloudFormation  >  Operations  >  execute_change_set

execute_change_set

Operation

execute_change_set async 

execute_change_set(input: ExecuteChangeSetInput, plugins: list[Plugin] | None = None) -> ExecuteChangeSetOutput

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.

Parameters:

Name Type Description Default
input ExecuteChangeSetInput

An instance of ExecuteChangeSetInput.

 required
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

 None

Returns:

Type Description
ExecuteChangeSetOutput

An instance of ExecuteChangeSetOutput.

Input

ExecuteChangeSetInput dataclass

Bases: _SerdeShape

The input for the ExecuteChangeSet action.

Attributes

change_set_name class-attribute instance-attribute 
change_set_name: str | None = ...

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

client_request_token class-attribute instance-attribute 
client_request_token: str | None = ...

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.

disable_rollback class-attribute instance-attribute 
disable_rollback: bool | None = ...

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

retain_except_on_create class-attribute instance-attribute 
retain_except_on_create: bool | None = ...

When set to true, newly created resources are deleted when the operation rolls back. This includes newly created resources marked with a deletion policy of Retain.

Default: false

stack_name class-attribute instance-attribute 
stack_name: str | None = ...

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.

Output

ExecuteChangeSetOutput dataclass

Bases: _SerdeShape

The output for the ExecuteChangeSet action.

Attributes

response_metadata class-attribute instance-attribute 
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.