You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::CloudFormation::Types::DeleteStackInput

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

Overview

Note:

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

{
  stack_name: "StackName", # required
  retain_resources: ["LogicalResourceId"],
  role_arn: "RoleARN",
  client_request_token: "ClientRequestToken",
}

The input for DeleteStack action.

Instance Attribute Summary collapse

Instance Attribute Details

#client_request_tokenString

A unique identifier for this DeleteStack request. Specify this token if you plan to retry requests so that AWS CloudFormation knows that you're not attempting to delete a stack with the same name. You might retry DeleteStack requests to ensure that AWS CloudFormation successfully received them.

All events triggered 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.

Returns:

  • (String)


1140
1141
1142
1143
1144
1145
1146
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 1140

class DeleteStackInput < Struct.new(
  :stack_name,
  :retain_resources,
  :role_arn,
  :client_request_token)
  include Aws::Structure
end

#retain_resourcesArray<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, AWS CloudFormation deletes the stack but does not delete the retained resources.

Retaining resources is useful when you cannot delete a resource, such as a non-empty S3 bucket, but you want to delete the stack.

Returns:

  • (Array<String>)


1140
1141
1142
1143
1144
1145
1146
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 1140

class DeleteStackInput < Struct.new(
  :stack_name,
  :retain_resources,
  :role_arn,
  :client_request_token)
  include Aws::Structure
end

#role_arnString

The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation assumes to delete the stack. AWS CloudFormation uses the role's credentials to make calls on your behalf.

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

Returns:

  • (String)


1140
1141
1142
1143
1144
1145
1146
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 1140

class DeleteStackInput < Struct.new(
  :stack_name,
  :retain_resources,
  :role_arn,
  :client_request_token)
  include Aws::Structure
end

#stack_nameString

The name or the unique stack ID that is associated with the stack.

Returns:

  • (String)


1140
1141
1142
1143
1144
1145
1146
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 1140

class DeleteStackInput < Struct.new(
  :stack_name,
  :retain_resources,
  :role_arn,
  :client_request_token)
  include Aws::Structure
end