Skip to contents

Returns information about all provisioned clusters if no cluster identifier is specified, or about a specific cache cluster if a cluster identifier is supplied

Source: R/elasticache_operations.R
elasticache_describe_cache_clusters.Rd

Returns information about all provisioned clusters if no cluster identifier is specified, or about a specific cache cluster if a cluster identifier is supplied.

See https://www.paws-r-sdk.com/docs/elasticache_describe_cache_clusters/ for full documentation.

Usage

elasticache_describe_cache_clusters(
  CacheClusterId = NULL,
  MaxRecords = NULL,
  Marker = NULL,
  ShowCacheNodeInfo = NULL,
  ShowCacheClustersNotInReplicationGroups = NULL
)

Arguments

CacheClusterId

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

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.

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.

ShowCacheNodeInfo

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

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 means Memcached and single node Valkey or Redis OSS clusters.