@Generated(value="software.amazon.awssdk:codegen") public final class DeleteStackRequest extends CloudFormationRequest implements ToCopyableBuilder<DeleteStackRequest.Builder,DeleteStackRequest>
The input for DeleteStack action.
| Modifier and Type | Class and Description |
|---|---|
static interface |
DeleteStackRequest.Builder |
| Modifier and Type | Method and Description |
|---|---|
static DeleteStackRequest.Builder |
builder() |
String |
clientRequestToken()
A unique identifier for this
DeleteStack request. |
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest. |
int |
hashCode() |
List<String> |
retainResources()
For stacks in the
DELETE_FAILED state, a list of resource logical IDs that are associated with the
resources you want to retain. |
String |
roleARN()
The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation
assumes to delete the stack.
|
static Class<? extends DeleteStackRequest.Builder> |
serializableBuilderClass() |
String |
stackName()
The name or the unique stack ID that is associated with the stack.
|
DeleteStackRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
overrideConfigurationcopypublic String stackName()
The name or the unique stack ID that is associated with the stack.
public List<String> retainResources()
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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
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.
public String roleARN()
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.
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.
public String clientRequestToken()
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.
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.
public DeleteStackRequest.Builder toBuilder()
ToCopyableBuildertoBuilder in interface ToCopyableBuilder<DeleteStackRequest.Builder,DeleteStackRequest>toBuilder in class CloudFormationRequestpublic static DeleteStackRequest.Builder builder()
public static Class<? extends DeleteStackRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequestSdkRequest. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will
again be available.getValueForField in class SdkRequestfieldName - The name of the member to be retrieved.clazz - The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.