@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) |
boolean |
equalsBySdkFields(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
boolean |
hasRetainResources()
For responses, this returns true if the service returned a value for the RetainResources property.
|
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 Identity and Access Management (IAM) role that CloudFormation assumes to
delete the stack.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends DeleteStackRequest.Builder> |
serializableBuilderClass() |
String |
stackName()
The name or the unique stack ID that's associated with the stack.
|
DeleteStackRequest.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
overrideConfigurationclone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final String stackName()
The name or the unique stack ID that's associated with the stack.
public final boolean hasRetainResources()
isEmpty() method on the property).
This is useful because the SDK will never return a null collection or map, but you may need to differentiate
between the service returning nothing (or null) and the service returning an empty collection or map. For
requests, this returns true if a value for the property was specified in the request builder, and false if a
value was not specified.public final 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, 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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasRetainResources() method.
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.
public final String roleARN()
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.
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.
public final String clientRequestToken()
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.
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.
public DeleteStackRequest.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<DeleteStackRequest.Builder,DeleteStackRequest>toBuilder in class CloudFormationRequestpublic static DeleteStackRequest.Builder builder()
public static Class<? extends DeleteStackRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsRequestpublic final boolean equals(Object obj)
equals in class AwsRequestpublic final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField in class SdkRequestCopyright © 2023. All rights reserved.