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 Identity and Access Management 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