Package software.amazon.awssdk.services.cloudformation.model

Class DeleteStackRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

software.amazon.awssdk.services.cloudformation.model.DeleteStackRequest

All Implemented Interfaces:

Cloneable, ReadLimitInfo, ToCopyableBuilder<DeleteStackRequest.Builder,DeleteStackRequest>

@Generated("software.amazon.awssdk:codegen")
public class DeleteStackRequest
extends AmazonWebServiceRequest
implements ToCopyableBuilder<DeleteStackRequest.Builder,DeleteStackRequest>

The input for DeleteStack action.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DeleteStackRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

Modifier and Type	Method	Description
static DeleteStackRequest.Builder	builder()
String	clientRequestToken()	A unique identifier for this DeleteStack request.
boolean	equals(Object obj)
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()

Methods inherited from class software.amazon.awssdk.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

stackName

public String stackName()

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

Returns:

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

retainResources

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.

Returns:

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.

roleARN

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.

Returns:

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.

clientRequestToken

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.

Returns:

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.

toBuilder

public DeleteStackRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<DeleteStackRequest.Builder,DeleteStackRequest>

Returns:

a builder for type T

builder

public static DeleteStackRequest.Builder builder()

serializableBuilderClass

public static Class<? extends DeleteStackRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object