Class: Aws::CloudFormation::Types::ContinueUpdateRollbackInput

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-cloudformation/types.rb

Overview

Note:

When making an API call, you may pass ContinueUpdateRollbackInput data as a hash:

{
  stack_name: "StackNameOrId", # required
  role_arn: "RoleARN",
  resources_to_skip: ["ResourceToSkip"],
  client_request_token: "ClientRequestToken",
}

The input for the ContinueUpdateRollback action.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#client_request_tokenString

A unique identifier for this `ContinueUpdateRollback` request. Specify this token if you plan to retry requests so that CloudFormationknows that you're not attempting to continue the rollback to a stack with the same name. You might retry `ContinueUpdateRollback` requests to ensure that CloudFormation successfully received them.

Returns:

  • (String)

609
610
611
612
613
614
615
616
# File 'lib/aws-sdk-cloudformation/types.rb', line 609

class ContinueUpdateRollbackInput < Struct.new(
  :stack_name,
  :role_arn,
  :resources_to_skip,
  :client_request_token)
  SENSITIVE = []
  include Aws::Structure
end

#resources_to_skipArray<String>

A list of the logical IDs of the resources that CloudFormation skips during the continue update rollback operation. You can specify only resources that are in the `UPDATE_FAILED` state because a rollback failed. You can't specify resources that are in the `UPDATE_FAILED` state for other reasons, for example, because an update was cancelled. To check why a resource update failed, use the DescribeStackResources action, and view the resource status reason.

Specify this property to skip rolling back resources that CloudFormation can't successfully roll back. We recommend that you

troubleshoot][1

resources before skipping them. CloudFormation

sets the status of the specified resources to `UPDATE_COMPLETE` and continues to roll back the stack. After the rollback is complete, the state of the skipped resources will be inconsistent with the state of the resources in the stack template. Before performing another stack update, you must update the stack or resources to be consistent with each other. If you don't, subsequent stack updates might fail, and the stack will become unrecoverable.

Specify the minimum number of resources required to successfully roll back your stack. For example, a failed resource update might cause dependent resources to fail. In this case, it might not be necessary to skip the dependent resources.

To skip resources that are part of nested stacks, use the following format: `NestedStackName.ResourceLogicalID`. If you want to specify the logical ID of a stack resource (`Type: AWS::CloudFormation::Stack`) in the `ResourcesToSkip` list, then its corresponding embedded stack must be in one of the following states: `DELETE_IN_PROGRESS`, `DELETE_COMPLETE`, or `DELETE_FAILED`.

<note markdown=“1”> Don't confuse a child stack's name with its corresponding logical ID defined in the parent stack. For an example of a continue update rollback operation with nested stacks, see [Using ResourcesToSkip to recover a nested stacks hierarchy].

</note>

[1]: docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/troubleshooting.html#troubleshooting-errors-update-rollback-failed [2]: docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-continueupdaterollback.html#nested-stacks

Returns:

  • (Array<String>)

609
610
611
612
613
614
615
616
# File 'lib/aws-sdk-cloudformation/types.rb', line 609

class ContinueUpdateRollbackInput < Struct.new(
  :stack_name,
  :role_arn,
  :resources_to_skip,
  :client_request_token)
  SENSITIVE = []
  include Aws::Structure
end

#role_arnString

The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes to roll back the stack. CloudFormation uses the role's credentials to make calls on your behalf. CloudFormation always uses this role for all future operations on the stack. As long as users have permission to operate on the stack, CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least privilege.

If you don't specify a value, CloudFormation uses the role that was previously associated with the stack. If no role is available, CloudFormation uses a temporary session that is generated from your user credentials.

Returns:

  • (String)

609
610
611
612
613
614
615
616
# File 'lib/aws-sdk-cloudformation/types.rb', line 609

class ContinueUpdateRollbackInput < Struct.new(
  :stack_name,
  :role_arn,
  :resources_to_skip,
  :client_request_token)
  SENSITIVE = []
  include Aws::Structure
end

#stack_nameString

The name or the unique ID of the stack that you want to continue rolling back.

<note markdown=“1”> Don't specify the name of a nested stack (a stack that was created by using the `AWS::CloudFormation::Stack` resource). Instead, use this operation on the parent stack (the stack that contains the `AWS::CloudFormation::Stack` resource).

</note>

Returns:

  • (String)

609
610
611
612
613
614
615
616
# File 'lib/aws-sdk-cloudformation/types.rb', line 609

class ContinueUpdateRollbackInput < Struct.new(
  :stack_name,
  :role_arn,
  :resources_to_skip,
  :client_request_token)
  SENSITIVE = []
  include Aws::Structure
end