Skip to content

/AWS1/CL_FRM=>ROLLBACKSTACK()

About RollbackStack

When specifying RollbackStack, you preserve the state of previously provisioned resources when an operation fails. You can check the status of the stack through the DescribeStacks operation.

Rolls back the specified stack to the last known stable state from CREATE_FAILED or UPDATE_FAILED stack statuses.

This operation will delete a stack if it doesn't contain a last known stable state. A last known stable state includes any status in a *_COMPLETE. This includes the following stack statuses.

  • CREATE_COMPLETE

  • UPDATE_COMPLETE

  • UPDATE_ROLLBACK_COMPLETE

  • IMPORT_COMPLETE

  • IMPORT_ROLLBACK_COMPLETE

Method Signature

IMPORTING

Required arguments:

iv_stackname TYPE /AWS1/FRMSTACKNAMEORID /AWS1/FRMSTACKNAMEORID

The name that's associated with the stack.

Optional arguments:

iv_rolearn TYPE /AWS1/FRMROLEARN /AWS1/FRMROLEARN

The Amazon Resource Name (ARN) of an IAM role that CloudFormation assumes to rollback the stack.

iv_clientrequesttoken TYPE /AWS1/FRMCLIENTREQUESTTOKEN /AWS1/FRMCLIENTREQUESTTOKEN

A unique identifier for this RollbackStack request.

iv_retainexceptoncreate TYPE /AWS1/FRMRETAINEXCEPTONCREATE /AWS1/FRMRETAINEXCEPTONCREATE

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

RETURNING

oo_output TYPE REF TO /aws1/cl_frmrollbackstackout /AWS1/CL_FRMROLLBACKSTACKOUT

Domain /AWS1/RT_ACCOUNT_ID
Primitive Type NUMC

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.

DATA(lo_result) = lo_client->/aws1/if_frm~rollbackstack(
  iv_clientrequesttoken = |string|
  iv_retainexceptoncreate = ABAP_TRUE
  iv_rolearn = |string|
  iv_stackname = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_stackid = lo_result->get_stackid( ).
ENDIF.