Class DeleteStackRequest
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
The input for DeleteStack action.
- See Also:
-
Field Summary
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
Creates a shallow clone of this request.boolean
For stacks in theDELETE_FAILED
state, a list of resource logical IDs that are associated with the resources you want to retain.The name or the unique stack ID that is associated with the stack.int
hashCode()
void
setRetainResources
(Collection<String> retainResources) For stacks in theDELETE_FAILED
state, a list of resource logical IDs that are associated with the resources you want to retain.void
setStackName
(String stackName) The name or the unique stack ID that is associated with the stack.toString()
Returns a string representation of this object; useful for testing and debugging.withRetainResources
(String... retainResources) For stacks in theDELETE_FAILED
state, a list of resource logical IDs that are associated with the resources you want to retain.withRetainResources
(Collection<String> retainResources) For stacks in theDELETE_FAILED
state, a list of resource logical IDs that are associated with the resources you want to retain.withStackName
(String stackName) The name or the unique stack ID that is associated with the stack.Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
-
Constructor Details
-
DeleteStackRequest
public DeleteStackRequest()
-
-
Method Details
-
setStackName
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.
-
getStackName
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.
-
withStackName
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.
-
getRetainResources
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.
-
setRetainResources
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 theDELETE_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.
-
withRetainResources
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)
orwithRetainResources(java.util.Collection)
if you want to override the existing values.- Parameters:
retainResources
- For stacks in theDELETE_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.
-
withRetainResources
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 theDELETE_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.
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
Description copied from class:AmazonWebServiceRequest
Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.- Overrides:
clone
in classAmazonWebServiceRequest
- See Also:
-