Skip to content

When specifying RollbackStack, you preserve the state of previously provisioned resources when an operation fails

Description

When specifying rollback_stack, you preserve the state of previously provisioned resources when an operation fails. You can check the status of the stack through the describe_stacks 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

Usage

cloudformation_rollback_stack(StackName, RoleARN, ClientRequestToken,
  RetainExceptOnCreate, DeploymentConfig)

Arguments

  • StackName

    [required] The name that's associated with the stack.

  • RoleARN

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

  • ClientRequestToken

    A unique identifier for this rollback_stack request.

  • RetainExceptOnCreate

    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

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

Value

A list with the following syntax:

list(
  StackId = "string",
  OperationId = "string"
)

Request syntax

svc$rollback_stack(
  StackName = "string",
  RoleARN = "string",
  ClientRequestToken = "string",
  RetainExceptOnCreate = TRUE|FALSE,
  DeploymentConfig = list(
    Mode = "STANDARD"|"EXPRESS",
    DisableRollback = TRUE|FALSE
  )
)