com.amazonaws.services.cloudformation.model

Class DeleteStackRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cloudformation.model.DeleteStackRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class DeleteStackRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

The input for DeleteStack action.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DeleteStackRequest()

Method Summary

Methods

Modifier and Type	Method and Description
DeleteStackRequest	clone()
boolean	equals(Object obj)
List<String>	getRetainResources() For stacks in the DELETE_FAILED state, a list of resource logical IDs that are associated with the resources you want to retain.
String	getStackName() The name or the unique stack ID that is associated with the stack.
int	hashCode()
void	setRetainResources(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.
void	setStackName(String stackName) The name or the unique stack ID that is associated with the stack.
String	toString() Returns a string representation of this object; useful for testing and debugging.
DeleteStackRequest	withRetainResources(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	withRetainResources(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	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, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DeleteStackRequest

public DeleteStackRequest()

Method Detail

setStackName

public void setStackName(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.

getStackName

public String 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

public DeleteStackRequest withStackName(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.

getRetainResources

public List<String> 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

public void setRetainResources(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.

withRetainResources

public DeleteStackRequest withRetainResources(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.

withRetainResources

public DeleteStackRequest withRetainResources(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.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public DeleteStackRequest clone()

Overrides:

clone in class AmazonWebServiceRequest