Describe Cache Clusters

elasticache_describe_cache_clusters

R Documentation

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

Description

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

By default, abbreviated information about the clusters is returned. You can use the optional ShowCacheNodeInfo flag to retrieve detailed information about the cache nodes associated with the 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 is displayed until all of the nodes are successfully provisioned.

If the cluster is in the deleting state, only cluster-level information is displayed.

If cache nodes are currently being added to the cluster, node endpoint information and creation time for the additional nodes are not displayed until they are completely provisioned. When the cluster state is available, the cluster is ready for use.

If cache nodes are currently being removed from the cluster, no endpoint information for the removed nodes is displayed.

Usage

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

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.

Value

A list with the following syntax:

list(
  Marker = "string",
  CacheClusters = list(
    list(
      CacheClusterId = "string",
      ConfigurationEndpoint = list(
        Address = "string",
        Port = 123
      ),
      ClientDownloadLandingPage = "string",
      CacheNodeType = "string",
      Engine = "string",
      EngineVersion = "string",
      CacheClusterStatus = "string",
      NumCacheNodes = 123,
      PreferredAvailabilityZone = "string",
      PreferredOutpostArn = "string",
      CacheClusterCreateTime = as.POSIXct(
        "2015-01-01"
      ),
      PreferredMaintenanceWindow = "string",
      PendingModifiedValues = list(
        NumCacheNodes = 123,
        CacheNodeIdsToRemove = list(
          "string"
        ),
        EngineVersion = "string",
        CacheNodeType = "string",
        AuthTokenStatus = "SETTING"|"ROTATING",
        LogDeliveryConfigurations = list(
          list(
            LogType = "slow-log"|"engine-log",
            DestinationType = "cloudwatch-logs"|"kinesis-firehose",
            DestinationDetails = list(
              CloudWatchLogsDetails = list(
                LogGroup = "string"
              ),
              KinesisFirehoseDetails = list(
                DeliveryStream = "string"
              )
            ),
            LogFormat = "text"|"json"
          )
        ),
        TransitEncryptionEnabled = TRUE|FALSE,
        TransitEncryptionMode = "preferred"|"required"
      ),
      NotificationConfiguration = list(
        TopicArn = "string",
        TopicStatus = "string"
      ),
      CacheSecurityGroups = list(
        list(
          CacheSecurityGroupName = "string",
          Status = "string"
        )
      ),
      CacheParameterGroup = list(
        CacheParameterGroupName = "string",
        ParameterApplyStatus = "string",
        CacheNodeIdsToReboot = list(
          "string"
        )
      ),
      CacheSubnetGroupName = "string",
      CacheNodes = list(
        list(
          CacheNodeId = "string",
          CacheNodeStatus = "string",
          CacheNodeCreateTime = as.POSIXct(
            "2015-01-01"
          ),
          Endpoint = list(
            Address = "string",
            Port = 123
          ),
          ParameterGroupStatus = "string",
          SourceCacheNodeId = "string",
          CustomerAvailabilityZone = "string",
          CustomerOutpostArn = "string"
        )
      ),
      AutoMinorVersionUpgrade = TRUE|FALSE,
      SecurityGroups = list(
        list(
          SecurityGroupId = "string",
          Status = "string"
        )
      ),
      ReplicationGroupId = "string",
      SnapshotRetentionLimit = 123,
      SnapshotWindow = "string",
      AuthTokenEnabled = TRUE|FALSE,
      AuthTokenLastModifiedDate = as.POSIXct(
        "2015-01-01"
      ),
      TransitEncryptionEnabled = TRUE|FALSE,
      AtRestEncryptionEnabled = TRUE|FALSE,
      ARN = "string",
      ReplicationGroupLogDeliveryEnabled = TRUE|FALSE,
      LogDeliveryConfigurations = list(
        list(
          LogType = "slow-log"|"engine-log",
          DestinationType = "cloudwatch-logs"|"kinesis-firehose",
          DestinationDetails = list(
            CloudWatchLogsDetails = list(
              LogGroup = "string"
            ),
            KinesisFirehoseDetails = list(
              DeliveryStream = "string"
            )
          ),
          LogFormat = "text"|"json",
          Status = "active"|"enabling"|"modifying"|"disabling"|"error",
          Message = "string"
        )
      ),
      NetworkType = "ipv4"|"ipv6"|"dual_stack",
      IpDiscovery = "ipv4"|"ipv6",
      TransitEncryptionMode = "preferred"|"required"
    )
  )
)

Request syntax

svc$describe_cache_clusters(
  CacheClusterId = "string",
  MaxRecords = 123,
  Marker = "string",
  ShowCacheNodeInfo = TRUE|FALSE,
  ShowCacheClustersNotInReplicationGroups = TRUE|FALSE
)

Examples

## Not run: 
# Lists the details for up to 50 cache clusters.
svc$describe_cache_clusters(
  CacheClusterId = "my-mem-cluster"
)

# Lists the details for the cache cluster my-mem-cluster.
svc$describe_cache_clusters(
  CacheClusterId = "my-mem-cluster",
  ShowCacheNodeInfo = TRUE
)

## End(Not run)