You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::ElastiCache::Types::DescribeCacheClustersMessage
- Inherits:
-
Struct
- Object
- Struct
- Aws::ElastiCache::Types::DescribeCacheClustersMessage
- Defined in:
- (unknown)
Overview
When passing DescribeCacheClustersMessage as input to an Aws::Client method, you can use a vanilla Hash:
{
cache_cluster_id: "String",
max_records: 1,
marker: "String",
show_cache_node_info: false,
show_cache_clusters_not_in_replication_groups: false,
}
Represents the input of a DescribeCacheClusters
operation.
Instance Attribute Summary collapse
-
#cache_cluster_id ⇒ String
The user-supplied cluster identifier.
-
#marker ⇒ String
An optional marker returned from a prior request.
-
#max_records ⇒ Integer
The maximum number of records to include in the response.
-
#show_cache_clusters_not_in_replication_groups ⇒ Boolean
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. -
#show_cache_node_info ⇒ Boolean
An optional flag that can be included in the
DescribeCacheCluster
request to retrieve information about the individual cache nodes.
Instance Attribute Details
#cache_cluster_id ⇒ String
The user-supplied cluster identifier. If this parameter is specified, only information about that specific cluster is returned. This parameter isn\'t case sensitive.
#marker ⇒ String
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
.
#max_records ⇒ Integer
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.
#show_cache_clusters_not_in_replication_groups ⇒ Boolean
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.
#show_cache_node_info ⇒ Boolean
An optional flag that can be included in the DescribeCacheCluster
request to retrieve information about the individual cache nodes.