DeleteReplicationGroupRequest Class

Container for the parameters to the DeleteReplicationGroup operation. Deletes an existing replication group. By default, this operation deletes the entire replication group, including the primary/primaries and all of the read replicas. If the replication group has only one primary, you can optionally delete only the read replicas, while retaining the primary by setting RetainPrimaryCluster=true.

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

This operation is valid for Redis only.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.ElastiCache.AmazonElastiCacheRequest
      Amazon.ElastiCache.Model.DeleteReplicationGroupRequest

Namespace: Amazon.ElastiCache.Model
Assembly: AWSSDK.ElastiCache.dll
Version: 3.x.y.z

Syntax

public class DeleteReplicationGroupRequest : AmazonElastiCacheRequest
         IAmazonWebServiceRequest

The DeleteReplicationGroupRequest type exposes the following members

Constructors

	Name	Description
	DeleteReplicationGroupRequest()

Properties

Name Type Description

Name	Type	Description
FinalSnapshotIdentifier	System.String	Gets and sets the property FinalSnapshotIdentifier. The name of a final node group (shard) 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 replication group is immediately deleted.
ReplicationGroupId	System.String	Gets and sets the property ReplicationGroupId. The identifier for the cluster to be deleted. This parameter is not case sensitive.
RetainPrimaryCluster	System.Boolean	Gets and sets the property RetainPrimaryCluster. If set to `true`, all of the read replicas are deleted, but the primary node is retained.

FinalSnapshotIdentifier

System.String

Gets and sets the property FinalSnapshotIdentifier.

The name of a final node group (shard) 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 replication group is immediately deleted.

ReplicationGroupId

System.String

Gets and sets the property ReplicationGroupId.

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

RetainPrimaryCluster

System.Boolean

Gets and sets the property RetainPrimaryCluster.

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

Examples

Deletes the Amazon ElastiCache replication group my-redis-rg.

DeleteReplicationGroup


var client = new AmazonElastiCacheClient();
var response = client.DeleteReplicationGroup(new DeleteReplicationGroupRequest 
{
    ReplicationGroupId = "my-redis-rg",
    RetainPrimaryCluster = false
});

ReplicationGroup replicationGroup = response.ReplicationGroup;

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5