Cancel Update Stack

cloudformation_cancel_update_stack

R Documentation

Cancels an update on the specified stack¶

Description¶

Cancels an update on the specified stack. If the call completes successfully, the stack rolls back the update and reverts to the previous stack configuration.

You can cancel only stacks that are in the UPDATE_IN_PROGRESS state.

Usage¶

cloudformation_cancel_update_stack(StackName, ClientRequestToken)

Arguments¶

StackName

[required] If you don't pass a parameter to StackName, the API returns a response that describes all resources in the account.

The IAM policy below can be added to IAM policies when you want to limit resource-level permissions and avoid returning a response when no parameter is sent in the request:

⁠{ "Version": "2012-10-17", "Statement": [{ "Effect": "Deny", "Action": "cloudformation:DescribeStacks", "NotResource": "arn:aws:cloudformation:*:*:stack/*/*" }] }⁠

The name or the unique stack ID that's associated with the stack.

ClientRequestToken

A unique identifier for this cancel_update_stack request. Specify this token if you plan to retry requests so that CloudFormation knows that you're not attempting to cancel an update on a stack with the same name. You might retry cancel_update_stack requests to ensure that CloudFormation successfully received them.

Value¶

An empty list.

Request syntax¶

svc$cancel_update_stack(
  StackName = "string",
  ClientRequestToken = "string"
)