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.

Container for the parameters to the DescribeCacheClusters operation. 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.

Inheritance Hierarchy

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

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

Syntax

C#
public class DescribeCacheClustersRequest : AmazonElastiCacheRequest
         IAmazonWebServiceRequest

The DescribeCacheClustersRequest type exposes the following members

Constructors

NameDescription
Public Method DescribeCacheClustersRequest()

Empty constructor used to set properties independently even when a simple constructor is available

Properties

NameTypeDescription
Public Property CacheClusterId System.String

Gets and sets the property CacheClusterId.

The user-supplied cluster identifier. If this parameter is specified, only information about that specific cache cluster is returned. This parameter isn't case sensitive.

Public Property Marker System.String

Gets and sets the property Marker.

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Public Property MaxRecords System.Int32

Gets and sets the property MaxRecords.

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: minimum 20; maximum 100.

Public Property ShowCacheClustersNotInReplicationGroups System.Boolean

Gets and sets the property ShowCacheClustersNotInReplicationGroups.

An optional flag that can be included in the DescribeCacheCluster request to show only nodes (API/CLI: clusters) that are not members of a replication group. In practice, this mean Memcached and single node Redis clusters.

Public Property ShowCacheNodeInfo System.Boolean

Gets and sets the property ShowCacheNodeInfo.

An optional flag that can be included in the DescribeCacheCluster request to retrieve information about the individual cache nodes.

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 Standard:
Supported in: 1.3

.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