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 a previously provisioned cluster. DeleteCacheCluster deletes all associated cache nodes, node endpoints and the cluster itself. When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the cluster; you cannot cancel or revert this operation.

This operation is not valid for:

Note:

For .NET Core this operation is only available in asynchronous form. Please refer to DeleteCacheClusterAsync.

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

Syntax

C#
public virtual DeleteCacheClusterResponse DeleteCacheCluster(
         DeleteCacheClusterRequest request
)

Parameters

request
Type: Amazon.ElastiCache.Model.DeleteCacheClusterRequest

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

Return Value


The response from the DeleteCacheCluster service method, as returned by ElastiCache.

Exceptions

ExceptionCondition
CacheClusterNotFoundException The requested cluster ID does not refer to an existing cluster.
InvalidCacheClusterStateException The requested cluster is not in the available state.
InvalidParameterCombinationException Two or more incompatible parameters were specified.
InvalidParameterValueException The value for a parameter is invalid.
SnapshotAlreadyExistsException You already have a snapshot with the given name.
SnapshotFeatureNotSupportedException You attempted one of the following operations: Creating a snapshot of a Redis cluster running on a cache.t1.micro cache node. Creating a snapshot of a 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 an Amazon ElastiCache cluster.

DeleteCacheCluster


var client = new AmazonElastiCacheClient();
var response = client.DeleteCacheCluster(new DeleteCacheClusterRequest 
{
    CacheClusterId = "my-memcached"
});

CacheCluster cacheCluster = response.CacheCluster;

            

Version Information

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

See Also