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(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.
Declaration Syntax| C# |
public class DescribeCacheClustersRequest : AmazonWebServiceRequest
Members| All Members | Constructors | Methods | Properties | ||
| Icon | Member | Description |
|---|---|---|
 | DescribeCacheClustersRequest()()()() | Initializes a new instance of the DescribeCacheClustersRequest class |
 | 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.
|
| Equals(Object) | (Inherited from Object.) |
| GetHashCode()()()() | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetType()()()() | Gets the type of the current instance. (Inherited from Object.) |
| 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.
|
| 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: 100Constraints: minimum 20; maximum 100.
|
| ShowCacheNodeInfo |
An optional flag that can be included in the DescribeCacheCluster request to retrieve information about the individual cache nodes.
|
| ToString()()()() | Returns a string that represents the current object. (Inherited from Object.) |
| WithCacheClusterId(String) | Obsolete.
Sets the CacheClusterId property
|
| WithMarker(String) | Obsolete.
Sets the Marker property
|
| WithMaxRecords(Int32) | Obsolete.
Sets the MaxRecords property
|
| WithShowCacheNodeInfo(Boolean) | Obsolete.
Sets the ShowCacheNodeInfo property
|
Inheritance Hierarchy| Object | ||
 | AmazonWebServiceRequest | |
| DescribeCacheClustersRequest | |