Class: Aws::CloudFormation::Types::DeleteStackInput
- Inherits:
-
Struct
- Object
- Struct
- Aws::CloudFormation::Types::DeleteStackInput
- Defined in:
- gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb
Overview
The input for DeleteStack action.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#client_request_token ⇒ String
A unique identifier for this
DeleteStack
request. -
#retain_resources ⇒ Array<String>
For stacks in the
DELETE_FAILED
state, a list of resource logical IDs that are associated with the resources you want to retain. -
#role_arn ⇒ String
The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes to delete the stack.
-
#stack_name ⇒ String
The name or the unique stack ID that's associated with the stack.
Instance Attribute Details
#client_request_token ⇒ String
A unique identifier for this DeleteStack
request. Specify this
token if you plan to retry requests so that CloudFormation knows
that you're not attempting to delete a stack with the same name.
You might retry DeleteStack
requests to ensure that CloudFormation
successfully received them.
All events initiated by a given stack operation are assigned the
same client request token, which you can use to track operations.
For example, if you execute a CreateStack
operation with the token
token1
, then all the StackEvents
generated by that operation
will have ClientRequestToken
set as token1
.
In the console, stack operations display the client request token on
the Events tab. Stack operations that are initiated from the console
use the token format Console-StackOperation-ID, which helps you
easily identify the stack operation . For example, if you create a
stack using the console, each stack event would be assigned the same
token in the following format:
Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002
.
1995 1996 1997 1998 1999 2000 2001 2002 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 1995 class DeleteStackInput < Struct.new( :stack_name, :retain_resources, :role_arn, :client_request_token) SENSITIVE = [] include Aws::Structure end |
#retain_resources ⇒ Array<String>
For stacks in the DELETE_FAILED
state, a list of resource logical
IDs that are associated with the resources you want to retain.
During deletion, CloudFormation deletes the stack but doesn't
delete the retained resources.
Retaining resources is useful when you can't delete a resource, such as a non-empty S3 bucket, but you want to delete the stack.
1995 1996 1997 1998 1999 2000 2001 2002 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 1995 class DeleteStackInput < Struct.new( :stack_name, :retain_resources, :role_arn, :client_request_token) SENSITIVE = [] include Aws::Structure end |
#role_arn ⇒ String
The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes to delete the stack. CloudFormation uses the role's credentials to make calls on your behalf.
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's generated from your user credentials.
1995 1996 1997 1998 1999 2000 2001 2002 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 1995 class DeleteStackInput < Struct.new( :stack_name, :retain_resources, :role_arn, :client_request_token) SENSITIVE = [] include Aws::Structure end |
#stack_name ⇒ String
The name or the unique stack ID that's associated with the stack.
1995 1996 1997 1998 1999 2000 2001 2002 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 1995 class DeleteStackInput < Struct.new( :stack_name, :retain_resources, :role_arn, :client_request_token) SENSITIVE = [] include Aws::Structure end |