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

Interface DeleteStackRequest.Builder

All Superinterfaces:

CopyableBuilder<DeleteStackRequest.Builder,DeleteStackRequest>, SdkBuilder<DeleteStackRequest.Builder,DeleteStackRequest>

Enclosing class:

DeleteStackRequest

public static interface DeleteStackRequest.Builder
extends CopyableBuilder<DeleteStackRequest.Builder,DeleteStackRequest>

Method Summary

Modifier and Type	Method	Description
DeleteStackRequest.Builder	clientRequestToken(String clientRequestToken)	A unique identifier for this DeleteStack request.
DeleteStackRequest.Builder	retainResources(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.
DeleteStackRequest.Builder	retainResources(Collection<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.
DeleteStackRequest.Builder	roleARN(String roleARN)	The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation assumes to delete the stack.
DeleteStackRequest.Builder	stackName(String stackName)	The name or the unique stack ID that is associated with the stack.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

apply, build

Method Detail

stackName

DeleteStackRequest.Builder stackName(String stackName)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

retainResources

DeleteStackRequest.Builder retainResources(Collection<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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

retainResources

DeleteStackRequest.Builder retainResources(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.

NOTE: This method appends the values to the existing list (if any). Use #setRetainResources(java.util.Collection) or #withRetainResources(java.util.Collection) if you want to override the existing values.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

roleARN

DeleteStackRequest.Builder roleARN(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

clientRequestToken

DeleteStackRequest.Builder clientRequestToken(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.