com.amazonaws.services.elasticache.model

Class DeleteReplicationGroupRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.elasticache.model.DeleteReplicationGroupRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class DeleteReplicationGroupRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the DeleteReplicationGroup operation.

The DeleteReplicationGroup action deletes an existing replication group. By default, this action deletes the entire replication group, including the primary cluster and all of the read replicas. You can optionally delete only the read replicas, while retaining the primary cluster.

When you receive a successful response from this action, Amazon ElastiCache immediately begins deleting the selected resources; you cannot cancel or revert this action.

See Also:

AmazonElastiCache.deleteReplicationGroup(DeleteReplicationGroupRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DeleteReplicationGroupRequest()

Method Summary

Methods

Modifier and Type	Method and Description
DeleteReplicationGroupRequest	clone()
boolean	equals(Object obj)
String	getFinalSnapshotIdentifier() The name of a final node group snapshot.
String	getReplicationGroupId() The identifier for the cluster to be deleted.
Boolean	getRetainPrimaryCluster() If set to true, all of the read replicas will be deleted, but the primary node will be retained.
int	hashCode()
Boolean	isRetainPrimaryCluster() If set to true, all of the read replicas will be deleted, but the primary node will be retained.
void	setFinalSnapshotIdentifier(String finalSnapshotIdentifier) The name of a final node group snapshot.
void	setReplicationGroupId(String replicationGroupId) The identifier for the cluster to be deleted.
void	setRetainPrimaryCluster(Boolean retainPrimaryCluster) If set to true, all of the read replicas will be deleted, but the primary node will be retained.
String	toString() Returns a string representation of this object; useful for testing and debugging.
DeleteReplicationGroupRequest	withFinalSnapshotIdentifier(String finalSnapshotIdentifier) The name of a final node group snapshot.
DeleteReplicationGroupRequest	withReplicationGroupId(String replicationGroupId) The identifier for the cluster to be deleted.
DeleteReplicationGroupRequest	withRetainPrimaryCluster(Boolean retainPrimaryCluster) If set to true, all of the read replicas will be deleted, but the primary node will be retained.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

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

Constructor Detail

DeleteReplicationGroupRequest

public DeleteReplicationGroupRequest()

Method Detail

getReplicationGroupId

public String getReplicationGroupId()

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

Returns:

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

setReplicationGroupId

public void setReplicationGroupId(String replicationGroupId)

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

Parameters:

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

withReplicationGroupId

public DeleteReplicationGroupRequest withReplicationGroupId(String replicationGroupId)

The 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:

replicationGroupId - The 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.

isRetainPrimaryCluster

public Boolean isRetainPrimaryCluster()

If set to true, all of the read replicas will be deleted, but the primary node will be retained.

Returns:

If set to true, all of the read replicas will be deleted, but the primary node will be retained.

setRetainPrimaryCluster

public void setRetainPrimaryCluster(Boolean retainPrimaryCluster)

If set to true, all of the read replicas will be deleted, but the primary node will be retained.

Parameters:

retainPrimaryCluster - If set to true, all of the read replicas will be deleted, but the primary node will be retained.

withRetainPrimaryCluster

public DeleteReplicationGroupRequest withRetainPrimaryCluster(Boolean retainPrimaryCluster)

If set to true, all of the read replicas will be deleted, but the primary node will be retained.

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

Parameters:

retainPrimaryCluster - If set to true, all of the read replicas will be deleted, but the primary node will be retained.

Returns:

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

getRetainPrimaryCluster

public Boolean getRetainPrimaryCluster()

If set to true, all of the read replicas will be deleted, but the primary node will be retained.

Returns:

If set to true, all of the read replicas will be deleted, but the primary node will be retained.

getFinalSnapshotIdentifier

public String getFinalSnapshotIdentifier()

The name of a final node group snapshot. ElastiCache creates the snapshot from the primary node in the cluster, rather than one of the replicas; this is to ensure that it captures the freshest data. After the final snapshot is taken, the cluster is immediately deleted.

Returns:

The name of a final node group snapshot. ElastiCache creates the snapshot from the primary node in the cluster, rather than one of the replicas; this is to ensure that it captures the freshest data. After the final snapshot is taken, the cluster is immediately deleted.

setFinalSnapshotIdentifier

public void setFinalSnapshotIdentifier(String finalSnapshotIdentifier)

The name of a final node group snapshot. ElastiCache creates the snapshot from the primary node in the cluster, rather than one of the replicas; this is to ensure that it captures the freshest data. After the final snapshot is taken, the cluster is immediately deleted.

Parameters:

finalSnapshotIdentifier - The name of a final node group snapshot. ElastiCache creates the snapshot from the primary node in the cluster, rather than one of the replicas; this is to ensure that it captures the freshest data. After the final snapshot is taken, the cluster is immediately deleted.

withFinalSnapshotIdentifier

public DeleteReplicationGroupRequest withFinalSnapshotIdentifier(String finalSnapshotIdentifier)

The name of a final node group snapshot. ElastiCache creates the snapshot from the primary node in the cluster, rather than one of the replicas; this is to ensure that it captures the freshest data. After the final snapshot is taken, the cluster is immediately deleted.

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

Parameters:

finalSnapshotIdentifier - The name of a final node group snapshot. ElastiCache creates the snapshot from the primary node in the cluster, rather than one of the replicas; this is to ensure that it captures the freshest data. After the final snapshot is taken, the cluster is immediately deleted.

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

clone

public DeleteReplicationGroupRequest clone()

Overrides:

clone in class AmazonWebServiceRequest