com.amazonaws.services.elasticache.model

Class DeleteCacheClusterRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.elasticache.model.DeleteCacheClusterRequest

All Implemented Interfaces:

Serializable

public class DeleteCacheClusterRequest
extends AmazonWebServiceRequest
implements Serializable

Container for the parameters to the DeleteCacheCluster operation.

The DeleteCacheCluster operation deletes a previously provisioned cache cluster. DeleteCacheCluster deletes all associated cache nodes, node endpoints and the cache cluster itself. When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the cache cluster; you cannot cancel or revert this operation.

This API cannot be used to delete a cache cluster that is the last read replica of a replication group that has automatic failover mode enabled.

See Also:

AmazonElastiCache.deleteCacheCluster(DeleteCacheClusterRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DeleteCacheClusterRequest() Default constructor for a new DeleteCacheClusterRequest object.
DeleteCacheClusterRequest(String cacheClusterId) Constructs a new DeleteCacheClusterRequest object.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getCacheClusterId() The cache cluster identifier for the cluster to be deleted.
String	getFinalSnapshotIdentifier() The user-supplied name of a final cache cluster snapshot.
int	hashCode()
void	setCacheClusterId(String cacheClusterId) The cache cluster identifier for the cluster to be deleted.
void	setFinalSnapshotIdentifier(String finalSnapshotIdentifier) The user-supplied name of a final cache cluster snapshot.
String	toString() Returns a string representation of this object; useful for testing and debugging.
DeleteCacheClusterRequest	withCacheClusterId(String cacheClusterId) The cache cluster identifier for the cluster to be deleted.
DeleteCacheClusterRequest	withFinalSnapshotIdentifier(String finalSnapshotIdentifier) The user-supplied name of a final cache cluster snapshot.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, copyPrivateRequestParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

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

Constructor Detail

DeleteCacheClusterRequest

public DeleteCacheClusterRequest()

Default constructor for a new DeleteCacheClusterRequest object. Callers should use the setter or fluent setter (with...) methods to initialize this object after creating it.

DeleteCacheClusterRequest

public DeleteCacheClusterRequest(String cacheClusterId)

Constructs a new DeleteCacheClusterRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.

Parameters:

cacheClusterId - The cache cluster identifier for the cluster to be deleted. This parameter is not case sensitive.

Method Detail

getCacheClusterId

public String getCacheClusterId()

The cache cluster identifier for the cluster to be deleted. This parameter is not case sensitive.

Returns:

The cache cluster identifier for the cluster to be deleted. This parameter is not case sensitive.

setCacheClusterId

public void setCacheClusterId(String cacheClusterId)

The cache cluster identifier for the cluster to be deleted. This parameter is not case sensitive.

Parameters:

cacheClusterId - The cache cluster identifier for the cluster to be deleted. This parameter is not case sensitive.

withCacheClusterId

public DeleteCacheClusterRequest withCacheClusterId(String cacheClusterId)

The cache cluster identifier for the cluster to be deleted. This parameter is not case sensitive.

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

Parameters:

cacheClusterId - The cache cluster identifier for the cluster to be deleted. This parameter is not case sensitive.

Returns:

A reference to this updated object so that method calls can be chained together.

getFinalSnapshotIdentifier

public String getFinalSnapshotIdentifier()

The user-supplied name of a final cache cluster snapshot. This is the unique name that identifies the snapshot. ElastiCache creates the snapshot, and then deletes the cache cluster immediately afterward.

Returns:

The user-supplied name of a final cache cluster snapshot. This is the unique name that identifies the snapshot. ElastiCache creates the snapshot, and then deletes the cache cluster immediately afterward.

setFinalSnapshotIdentifier

public void setFinalSnapshotIdentifier(String finalSnapshotIdentifier)

The user-supplied name of a final cache cluster snapshot. This is the unique name that identifies the snapshot. ElastiCache creates the snapshot, and then deletes the cache cluster immediately afterward.

Parameters:

finalSnapshotIdentifier - The user-supplied name of a final cache cluster snapshot. This is the unique name that identifies the snapshot. ElastiCache creates the snapshot, and then deletes the cache cluster immediately afterward.

withFinalSnapshotIdentifier

public DeleteCacheClusterRequest withFinalSnapshotIdentifier(String finalSnapshotIdentifier)

The user-supplied name of a final cache cluster snapshot. This is the unique name that identifies the snapshot. ElastiCache creates the snapshot, and then deletes the cache cluster immediately afterward.

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

Parameters:

finalSnapshotIdentifier - The user-supplied name of a final cache cluster snapshot. This is the unique name that identifies the snapshot. ElastiCache creates the snapshot, and then deletes the cache cluster immediately afterward.

Returns:

A reference to this updated 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()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object