AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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.

Note:

For PCL this operation is only available in asynchronous form. Please refer to DeleteReplicationGroupAsync.

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

Syntax

C#
public virtual DeleteReplicationGroupResponse DeleteReplicationGroup(
         DeleteReplicationGroupRequest request
)
Parameters
request
Type: Amazon.ElastiCache.Model.DeleteReplicationGroupRequest

Container for the necessary parameters to execute the DeleteReplicationGroup service method.

Return Value
The response from the DeleteReplicationGroup service method, as returned by ElastiCache.

Exceptions

ExceptionCondition
InvalidParameterCombinationException Two or more incompatible parameters were specified.
InvalidParameterValueException The value for a parameter is invalid.
InvalidReplicationGroupStateException The requested replication group is not in the available state.
ReplicationGroupNotFoundException The specified replication group does not exist.
SnapshotAlreadyExistsException You already have a snapshot with the given name.
SnapshotFeatureNotSupportedException You attempted one of the following operations: Creating a snapshot of a Redis cache cluster running on a cache.t1.micro cache node. Creating a snapshot of a cache cluster that is running Memcached rather than Redis. Neither of these are supported by ElastiCache.
SnapshotQuotaExceededException The request cannot be processed because it would exceed the maximum number of snapshots.

Examples

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

DeleteReplicationGroup


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

ReplicationGroup replicationGroup = response.ReplicationGroup;

            

Version Information

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

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms

See Also