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 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 operation cannot be used to delete a cache cluster that is the last read replica of a replication group or node group (shard) that has Multi-AZ mode enabled or a cache cluster from a Redis (cluster mode enabled) replication group.

Due to current limitations on Redis (cluster mode disabled), this operation or parameter is not supported on Redis (cluster mode enabled) replication groups.

Note:

For PCL 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 abstract 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 cache cluster ID does not refer to an existing cache cluster.
InvalidCacheClusterStateException The requested cache 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 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 an Amazon ElastiCache cluster.

DeleteCacheCluster


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

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