AWS SDK Version 2 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.

.NET Framework 3.5
 
Container for the parameters to the DescribeCacheClusters operation. The DescribeCacheClusters action 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(s) will be returned. You can use the optional ShowDetails 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 will be displayed until all of the nodes are successfully provisioned.

If the cluster is in the DELETING state, only cluster level information will be displayed.

If cache nodes are currently being added to the cache cluster, node endpoint information and creation time for the additional nodes will not be 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.dll
Version: (assembly version)

Syntax

C#
public class DescribeCacheClustersRequest : AmazonElastiCacheRequest
         IRequestEvents

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 action. 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 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.

Version Information

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

.NET for Windows Store apps:
Supported in: Windows 8