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.
Cluster information will be returned by default. An optional ShowDetails flag can be used to retrieve detailed information about the Cache Nodes associated with the Cache Cluster. 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.
While adding Cache Nodes, node endpoint information and creation time for the additional nodes will not be displayed until they are completely provisioned. The cluster lifecycle tells the customer when new nodes are AVAILABLE.
While removing existing Cache Nodes from an cluster, endpoint information for the removed nodes will not be displayed.
DescribeCacheClusters supports pagination.
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 provided in the previous DescribeCacheClusters request. 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 may be retrieved. Default: 100 Constraints: minimum 20, maximum 100
|
| ShowCacheNodeInfo |
An optional flag that can be included in the DescribeCacheCluster request to retrieve Cache Nodes information.
|
| ToString()()()() | Returns a string that represents the current object. (Inherited from Object.) |
| WithCacheClusterId(String) |
Sets the CacheClusterId property
|
| WithMarker(String) |
Sets the Marker property
|
| WithMaxRecords(Int32) |
Sets the MaxRecords property
|
| WithShowCacheNodeInfo(Boolean) |
Sets the ShowCacheNodeInfo property
|
Inheritance Hierarchy| Object | ||
 | AmazonWebServiceRequest | |
| DescribeCacheClustersRequest | |
