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.

Returns information about all provisioned cache clusters if no cache cluster identifier is specified, or about a specific cache cluster if a cache cluster identifier is supplied.

By default, abbreviated information about the cache clusters is returned. You can use the optional ShowCacheNodeInfo flag to retrieve detailed information about the cache nodes associated with the cache clusters. These details include the DNS address and port for the cache node endpoint.

If the cluster is in the creating state, only cluster-level information is displayed until all of the nodes are successfully provisioned.

If the cluster is in the deleting state, only cluster-level information is displayed.

If cache nodes are currently being added to the cache cluster, node endpoint information and creation time for the additional nodes are not displayed until they are completely provisioned. When the cache cluster state is available, the cluster is ready for use.

If cache nodes are currently being removed from the cache cluster, no endpoint information for the removed nodes is displayed.

Note:

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

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

Syntax

C#
public abstract DescribeCacheClustersResponse DescribeCacheClusters(
         DescribeCacheClustersRequest request
)
Parameters
request
Type: Amazon.ElastiCache.Model.DescribeCacheClustersRequest

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

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

Exceptions

ExceptionCondition
CacheClusterNotFoundException The requested cache cluster ID does not refer to an existing cache cluster.
InvalidParameterCombinationException Two or more incompatible parameters were specified.
InvalidParameterValueException The value for a parameter is invalid.

Examples

Lists the details for up to 50 cache clusters.

DescribeCacheClusters


var response = client.DescribeCacheClusters(new DescribeCacheClustersRequest 
{
    CacheClusterId = "my-mem-cluster"
});

List cacheClusters = response.CacheClusters;

            

Lists the details for the cache cluster my-mem-cluster.

DescribeCacheClusters


var response = client.DescribeCacheClusters(new DescribeCacheClustersRequest 
{
    CacheClusterId = "my-mem-cluster"
});

List cacheClusters = response.CacheClusters;

            

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