/AWS1/IF_FRM=>CANCELUPDATESTACK()¶
About CancelUpdateStack¶
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.
Method Signature¶
METHODS /AWS1/IF_FRM~CANCELUPDATESTACK
IMPORTING
!IV_STACKNAME TYPE /AWS1/FRMSTACKNAME OPTIONAL
!IV_CLIENTREQUESTTOKEN TYPE /AWS1/FRMCLIENTREQUESTTOKEN OPTIONAL
RAISING
/AWS1/CX_FRMTOKENALRDYEXISTSEX
/AWS1/CX_FRMCLIENTEXC
/AWS1/CX_FRMSERVEREXC
/AWS1/CX_RT_TECHNICAL_GENERIC
/AWS1/CX_RT_SERVICE_GENERIC.
IMPORTING¶
Required arguments:¶
iv_stackname TYPE /AWS1/FRMSTACKNAME /AWS1/FRMSTACKNAME¶
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.
Optional arguments:¶
iv_clientrequesttoken TYPE /AWS1/FRMCLIENTREQUESTTOKEN /AWS1/FRMCLIENTREQUESTTOKEN¶
A unique identifier for this
CancelUpdateStackrequest. 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 retryCancelUpdateStackrequests to ensure that CloudFormation successfully received them.
Examples¶
Syntax Example¶
This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.
lo_client->cancelupdatestack(
iv_clientrequesttoken = |string|
iv_stackname = |string|
).