public static interface DeleteStackRequest.Builder extends CloudFormationRequest.Builder, SdkPojo, CopyableBuilder<DeleteStackRequest.Builder,DeleteStackRequest>
| Modifier and Type | Method and Description |
|---|---|
DeleteStackRequest.Builder |
clientRequestToken(String clientRequestToken)
A unique identifier for this
DeleteStack request. |
DeleteStackRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
Add an optional request override configuration.
|
DeleteStackRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
Add an optional request override configuration.
|
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 |
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 |
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.
|
buildoverrideConfigurationcopyapplyMutation, buildDeleteStackRequest.Builder stackName(String stackName)
The name or the unique stack ID that is associated with the stack.
stackName - The name or the unique stack ID that is associated with the stack.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.
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.
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.
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.
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.
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.
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.
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.
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.
DeleteStackRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
AwsRequest.BuilderoverrideConfiguration in interface AwsRequest.BuilderoverrideConfiguration - The override configuration.DeleteStackRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
AwsRequest.BuilderoverrideConfiguration in interface AwsRequest.BuilderbuilderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be
given.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.