CloudFormation / Client / rollback_stack

rollback_stack

CloudFormation.Client.rollback_stack(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.rollback_stack(
    StackName='string',
    RoleARN='string',
    ClientRequestToken='string',
    RetainExceptOnCreate=True|False,
    DeploymentConfig={
        'Mode': 'STANDARD'|'EXPRESS',
        'DisableRollback': True|False
    }
)
Parameters:

  • StackName (string) –

    [REQUIRED]

    The name that’s associated with the stack.

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

  • ClientRequestToken (string) – A unique identifier for this RollbackStack request.

  • RetainExceptOnCreate (boolean) –

    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

  • DeploymentConfig (dict) –

    The deployment configuration for this stack operation, including the deployment mode.

    • Mode (string) –

      Specifies the deployment mode for the stack operation. Possible values are:

      • STANDARD - Use the standard deployment behavior, ensuring resources are ready to serve traffic before completing the operation. This is the default. You do not need to specify this value explicitly.

      • EXPRESS - Complete the stack operation when resource configuration is applied, without waiting for resources to become ready to serve traffic. Resources continue becoming ready in the background.

    • DisableRollback (boolean) –

      Specifies whether to disable rollback of the stack if the stack operation fails.

      Default: false

Return type:

dict

Returns:

Response Syntax

{
    'StackId': 'string',
    'OperationId': 'string'
}

Response Structure

  • (dict) –

    • StackId (string) –

      Unique identifier of the stack.

    • OperationId (string) –

      A unique identifier for this rollback operation that can be used to track the operation’s progress and events.

Exceptions

  • CloudFormation.Client.exceptions.TokenAlreadyExistsException