Skip to content

Updates a stack using the input information that was provided when the specified change set was created

Description

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 describe_stacks 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.

Usage

cloudformation_execute_change_set(ChangeSetName, StackName,
  ClientRequestToken, DisableRollback, RetainExceptOnCreate)

Arguments

  • ChangeSetName

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

  • StackName

    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

    A unique identifier for this execute_change_set 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 execute_change_set requests to ensure that CloudFormation successfully received them.

  • DisableRollback

    Preserves the state of previously provisioned resources when an operation fails. This parameter can't be specified when the OnStackFailure parameter to the create_change_set 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 create_change_set API operation.
    • False - if the stack creation fails, roll back the stack. This is equivalent to specifying ROLLBACK for the OnStackFailure parameter to the create_change_set API operation.

    Default: True

  • RetainExceptOnCreate

    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

Value

An empty list.

Request syntax

svc$execute_change_set(
  ChangeSetName = "string",
  StackName = "string",
  ClientRequestToken = "string",
  DisableRollback = TRUE|FALSE,
  RetainExceptOnCreate = TRUE|FALSE
)