Amazon ElastiCache for Redis
ElastiCache for Redis User Guide (API Version 2015-02-02)

Viewing a Cluster's Details

You can view detail information about one or more clusters using the ElastiCache console, AWS CLI, or ElastiCache API.

Viewing a Redis (cluster mode disabled) Cluster's Details (Console)

You can view the details of a Redis (cluster mode disabled) cluster using the ElastiCache console, the AWS CLI for ElastiCache, or the ElastiCache API.

The following procedure details how to view the details of a Redis (cluster mode disabled) cluster using the ElastiCache console.

To view a Redis (cluster mode disabled) cluster's details

  1. Sign in to the AWS Management Console and open the Amazon ElastiCache console at https://console.aws.amazon.com/elasticache/.

  2. In the ElastiCache console dashboard, choose Redis to display a list of all your clusters that are running any version of Redis.

    
							Image: Memcached cluster list
  3. To see details of a cluster, select the check box to the left of the cluster's name. Make sure you select a cluster running the Redis engine, not Clustered Redis. Doing this displays details about the cluster, including the cluster's primary endpoint.

  4. To view node information:

    1. Choose the cluster's name.

    2. Choose the Nodes tab. Doing this displays details about each node, including the node's endpoint which you need to use to read from the cluster.

    3. To view metrics on one or more nodes, select the box to the left of the node ID, then select the time range for the metrics from the Time range list. If you select multiple nodes, you can see overlay graphs.

      Image: Metrics over the last hour for two Redis nodes

      Metrics over the last hour for two Redis nodes

Viewing a Redis (cluster mode enabled) Cluster's Details (Console)

You can view the details of a Redis (cluster mode enabled) cluster using the ElastiCache console, the AWS CLI for ElastiCache, or the ElastiCache API.

The following procedure details how to view the details of a Redis (cluster mode enabled) cluster using the ElastiCache console.

To view a Redis (cluster mode enabled) cluster's details

  1. Sign in to the AWS Management Console and open the Amazon ElastiCache console at https://console.aws.amazon.com/elasticache/.

  2. From the list in the upper-right corner, choose the AWS Region you are interested in.

  3. In the ElastiCache console dashboard, choose Redis to display a list of all your clusters that are running any version of Redis.

  4. To see details of a Redis (cluster mode enabled) cluster, choose the box to the left of the cluster's name. Make sure you choose a cluster running the Clustered Redis engine, not just Redis.

    The screen expands below the cluster and display details about the cluster, including the cluster's configuration endpoint.

  5. To see a listing of the cluster's shards and the number of nodes in each shard, choose the cluster's name.

  6. To view specific information on a node:

    1. Choose the shard's ID.

    2. Choose the Nodes tab.

      This will display information about each node, including each node's endpoint that you need to use to read data from the cluster.

    3. To view metrics on one or more nodes, choose the box to the left of the node's id, and then choose the time range for the metrics from the Time range list. Selecting multiple nodes will generate overlay graphs.

      Image: Metrics over the last hour for two Redis nodes

      Metrics over the last hour for two Redis nodes

Viewing a Cluster's Details (AWS CLI)

You can view the details for a cluster using the AWS CLI describe-cache-clusters command. If the --cache-cluster-id parameter is omitted, details for multiple clusters, up to --max-items, are returned. If the --cache-cluster-id parameter is included, details for the specified cluster are returned. You can limit the number of records returned with the --max-items parameter.

The following code lists the details for my-cluster.

aws elasticache describe-cache-clusters --cache-cluster-id my-cluster

The following code list the details for up to 25 clusters.

aws elasticache describe-cache-clusters --max-items 25

For Linux, macOS, or Unix:

aws elasticache describe-cache-clusters \ --cache-cluster-id my-cluster \ --show-cache-node-info

For Windows:

aws elasticache describe-cache-clusters ^ --cache-cluster-id my-cluster ^ --show-cache-node-info

This operation produces output similar to the following (JSON format):

The following JSON output is for three different Redis clusters:

  • my-cluster1 – a Redis (cluster mode disabled) cluster with 1 node.

  • my-cluster2 – a Redis (cluster mode disabled) cluster with 2 nodes, a primary and 1 read replica.

  • my-cluster22 – a Redis (cluster mode enabled) cluster with 2 shards, each shard having a primary node and 2 read replicas. This cluster has encryption enabled.

{ "CacheClusters": [ { "CacheClusterStatus": "available", "SecurityGroups": [ { "Status": "active", "SecurityGroupId": "sg-dbe93fa2" } ], "ClientDownloadLandingPage": "https://console.aws.amazon.com/elasticache/home#client-download:", "Engine": "redis", "PreferredMaintenanceWindow": "wed:12:00-wed:13:00", "CacheSubnetGroupName": "default", "SnapshotWindow": "08:30-09:30", "TransitEncryptionEnabled": false, "AtRestEncryptionEnabled": false, "CacheClusterId": "my-cluster1", "CacheClusterCreateTime": "2018-02-26T21:06:43.420Z", "PreferredAvailabilityZone": "us-west-2c", "AuthTokenEnabled": false, "PendingModifiedValues": {}, "CacheNodeType": "cache.r4.large", "CacheParameterGroup": { "CacheNodeIdsToReboot": [], "ParameterApplyStatus": "in-sync", "CacheParameterGroupName": "default.redis3.2" }, "SnapshotRetentionLimit": 0, "AutoMinorVersionUpgrade": true, "EngineVersion": "3.2.10", "CacheSecurityGroups": [], "NumCacheNodes": 1 }
{ "CacheClusters": [ { "SecurityGroups": [ { "Status": "active", "SecurityGroupId": "sg-dbe93fa2" } ], "ClientDownloadLandingPage": "https://console.aws.amazon.com/elasticache/home#client-download:", "AuthTokenEnabled": false, "CacheSubnetGroupName": "default", "SnapshotWindow": "12:30-13:30", "AutoMinorVersionUpgrade": true, "CacheClusterCreateTime": "2018-02-26T21:13:24.250Z", "CacheClusterStatus": "available", "AtRestEncryptionEnabled": false, "PreferredAvailabilityZone": "us-west-2a", "TransitEncryptionEnabled": false, "ReplicationGroupId": "my-cluster2", "Engine": "redis", "PreferredMaintenanceWindow": "sun:08:30-sun:09:30", "CacheClusterId": "my-cluster2-001", "PendingModifiedValues": {}, "CacheNodeType": "cache.r4.large", "CacheParameterGroup": { "CacheNodeIdsToReboot": [], "ParameterApplyStatus": "in-sync", "CacheParameterGroupName": "default.redis3.2" }, "SnapshotRetentionLimit": 0, "EngineVersion": "3.2.10", "CacheSecurityGroups": [], "NumCacheNodes": 1 }, { "SecurityGroups": [ { "Status": "active", "SecurityGroupId": "sg-dbe93fa2" } ], "ClientDownloadLandingPage": "https://console.aws.amazon.com/elasticache/home#client-download:", "AuthTokenEnabled": false, "CacheSubnetGroupName": "default", "SnapshotWindow": "12:30-13:30", "AutoMinorVersionUpgrade": true, "CacheClusterCreateTime": "2018-02-26T21:13:24.250Z", "CacheClusterStatus": "available", "AtRestEncryptionEnabled": false, "PreferredAvailabilityZone": "us-west-2b", "TransitEncryptionEnabled": false, "ReplicationGroupId": "my-cluster2", "Engine": "redis", "PreferredMaintenanceWindow": "sun:08:30-sun:09:30", "CacheClusterId": "my-cluster2-002", "PendingModifiedValues": {}, "CacheNodeType": "cache.r4.large", "CacheParameterGroup": { "CacheNodeIdsToReboot": [], "ParameterApplyStatus": "in-sync", "CacheParameterGroupName": "default.redis3.2" }, "SnapshotRetentionLimit": 0, "EngineVersion": "3.2.10", "CacheSecurityGroups": [], "NumCacheNodes": 1 }, { "SecurityGroups": [ { "Status": "active", "SecurityGroupId": "sg-dbe93fa2" } ], "ClientDownloadLandingPage": "https://console.aws.amazon.com/elasticache/home#client-download:", "AuthTokenEnabled": false, "CacheSubnetGroupName": "default", "SnapshotWindow": "12:30-13:30", "AutoMinorVersionUpgrade": true, "CacheClusterCreateTime": "2018-02-26T21:13:24.250Z", "CacheClusterStatus": "available", "AtRestEncryptionEnabled": false, "PreferredAvailabilityZone": "us-west-2c", "TransitEncryptionEnabled": false, "ReplicationGroupId": "my-cluster2", "Engine": "redis", "PreferredMaintenanceWindow": "sun:08:30-sun:09:30", "CacheClusterId": "my-cluster2-003", "PendingModifiedValues": {}, "CacheNodeType": "cache.r4.large", "CacheParameterGroup": { "CacheNodeIdsToReboot": [], "ParameterApplyStatus": "in-sync", "CacheParameterGroupName": "default.redis3.2" }, "SnapshotRetentionLimit": 0, "EngineVersion": "3.2.10", "CacheSecurityGroups": [], "NumCacheNodes": 1 }
{ "CacheClusters": [ { "SecurityGroups": [ { "Status": "active", "SecurityGroupId": "sg-dbe93fa2" } ], "ClientDownloadLandingPage": "https://console.aws.amazon.com/elasticache/home#client-download:", "AuthTokenEnabled": true, "CacheSubnetGroupName": "default", "SnapshotWindow": "12:30-13:30", "AutoMinorVersionUpgrade": true, "CacheClusterCreateTime": "2018-02-26T21:17:01.439Z", "CacheClusterStatus": "available", "AtRestEncryptionEnabled": true, "PreferredAvailabilityZone": "us-west-2a", "TransitEncryptionEnabled": true, "ReplicationGroupId": "my-cluster3", "Engine": "redis", "PreferredMaintenanceWindow": "thu:11:00-thu:12:00", "CacheClusterId": "my-cluster3-0001-001", "PendingModifiedValues": {}, "CacheNodeType": "cache.r4.large", "CacheParameterGroup": { "CacheNodeIdsToReboot": [], "ParameterApplyStatus": "in-sync", "CacheParameterGroupName": "default.redis3.2.cluster.on" }, "SnapshotRetentionLimit": 0, "EngineVersion": "3.2.6", "CacheSecurityGroups": [], "NumCacheNodes": 1 }, { "SecurityGroups": [ { "Status": "active", "SecurityGroupId": "sg-dbe93fa2" } ], "ClientDownloadLandingPage": "https://console.aws.amazon.com/elasticache/home#client-download:", "AuthTokenEnabled": true, "CacheSubnetGroupName": "default", "SnapshotWindow": "12:30-13:30", "AutoMinorVersionUpgrade": true, "CacheClusterCreateTime": "2018-02-26T21:17:01.439Z", "CacheClusterStatus": "available", "AtRestEncryptionEnabled": true, "PreferredAvailabilityZone": "us-west-2b", "TransitEncryptionEnabled": true, "ReplicationGroupId": "my-cluster3", "Engine": "redis", "PreferredMaintenanceWindow": "thu:11:00-thu:12:00", "CacheClusterId": "my-cluster3-0001-002", "PendingModifiedValues": {}, "CacheNodeType": "cache.r4.large", "CacheParameterGroup": { "CacheNodeIdsToReboot": [], "ParameterApplyStatus": "in-sync", "CacheParameterGroupName": "default.redis3.2.cluster.on" }, "SnapshotRetentionLimit": 0, "EngineVersion": "3.2.6", "CacheSecurityGroups": [], "NumCacheNodes": 1 }, { "SecurityGroups": [ { "Status": "active", "SecurityGroupId": "sg-dbe93fa2" } ], "ClientDownloadLandingPage": "https://console.aws.amazon.com/elasticache/home#client-download:", "AuthTokenEnabled": true, "CacheSubnetGroupName": "default", "SnapshotWindow": "12:30-13:30", "AutoMinorVersionUpgrade": true, "CacheClusterCreateTime": "2018-02-26T21:17:01.439Z", "CacheClusterStatus": "available", "AtRestEncryptionEnabled": true, "PreferredAvailabilityZone": "us-west-2c", "TransitEncryptionEnabled": true, "ReplicationGroupId": "my-cluster3", "Engine": "redis", "PreferredMaintenanceWindow": "thu:11:00-thu:12:00", "CacheClusterId": "my-cluster3-0001-003", "PendingModifiedValues": {}, "CacheNodeType": "cache.r4.large", "CacheParameterGroup": { "CacheNodeIdsToReboot": [], "ParameterApplyStatus": "in-sync", "CacheParameterGroupName": "default.redis3.2.cluster.on" }, "SnapshotRetentionLimit": 0, "EngineVersion": "3.2.6", "CacheSecurityGroups": [], "NumCacheNodes": 1 }, { "SecurityGroups": [ { "Status": "active", "SecurityGroupId": "sg-dbe93fa2" } ], "ClientDownloadLandingPage": "https://console.aws.amazon.com/elasticache/home#client-download:", "AuthTokenEnabled": true, "CacheSubnetGroupName": "default", "SnapshotWindow": "12:30-13:30", "AutoMinorVersionUpgrade": true, "CacheClusterCreateTime": "2018-02-26T21:17:01.439Z", "CacheClusterStatus": "available", "AtRestEncryptionEnabled": true, "PreferredAvailabilityZone": "us-west-2b", "TransitEncryptionEnabled": true, "ReplicationGroupId": "my-cluster3", "Engine": "redis", "PreferredMaintenanceWindow": "thu:11:00-thu:12:00", "CacheClusterId": "my-cluster3-0002-001", "PendingModifiedValues": {}, "CacheNodeType": "cache.r4.large", "CacheParameterGroup": { "CacheNodeIdsToReboot": [], "ParameterApplyStatus": "in-sync", "CacheParameterGroupName": "default.redis3.2.cluster.on" }, "SnapshotRetentionLimit": 0, "EngineVersion": "3.2.6", "CacheSecurityGroups": [], "NumCacheNodes": 1 }, { "SecurityGroups": [ { "Status": "active", "SecurityGroupId": "sg-dbe93fa2" } ], "ClientDownloadLandingPage": "https://console.aws.amazon.com/elasticache/home#client-download:", "AuthTokenEnabled": true, "CacheSubnetGroupName": "default", "SnapshotWindow": "12:30-13:30", "AutoMinorVersionUpgrade": true, "CacheClusterCreateTime": "2018-02-26T21:17:01.439Z", "CacheClusterStatus": "available", "AtRestEncryptionEnabled": true, "PreferredAvailabilityZone": "us-west-2c", "TransitEncryptionEnabled": true, "ReplicationGroupId": "my-cluster3", "Engine": "redis", "PreferredMaintenanceWindow": "thu:11:00-thu:12:00", "CacheClusterId": "my-cluster3-0002-002", "PendingModifiedValues": {}, "CacheNodeType": "cache.r4.large", "CacheParameterGroup": { "CacheNodeIdsToReboot": [], "ParameterApplyStatus": "in-sync", "CacheParameterGroupName": "default.redis3.2.cluster.on" }, "SnapshotRetentionLimit": 0, "EngineVersion": "3.2.6", "CacheSecurityGroups": [], "NumCacheNodes": 1 }, { "SecurityGroups": [ { "Status": "active", "SecurityGroupId": "sg-dbe93fa2" } ], "ClientDownloadLandingPage": "https://console.aws.amazon.com/elasticache/home#client-download:", "AuthTokenEnabled": true, "CacheSubnetGroupName": "default", "SnapshotWindow": "12:30-13:30", "AutoMinorVersionUpgrade": true, "CacheClusterCreateTime": "2018-02-26T21:17:01.439Z", "CacheClusterStatus": "available", "AtRestEncryptionEnabled": true, "PreferredAvailabilityZone": "us-west-2a", "TransitEncryptionEnabled": true, "ReplicationGroupId": "my-cluster3", "Engine": "redis", "PreferredMaintenanceWindow": "thu:11:00-thu:12:00", "CacheClusterId": "my-cluster3-0002-003", "PendingModifiedValues": {}, "CacheNodeType": "cache.r4.large", "CacheParameterGroup": { "CacheNodeIdsToReboot": [], "ParameterApplyStatus": "in-sync", "CacheParameterGroupName": "default.redis3.2.cluster.on" }, "SnapshotRetentionLimit": 0, "EngineVersion": "3.2.6", "CacheSecurityGroups": [], "NumCacheNodes": 1 } ] }

For more information, see the AWS CLI for ElastiCache topic describe-cache-clusters.

Viewing a Cluster's Details (ElastiCache API)

You can view the details for a cluster using the ElastiCache API DescribeCacheClusters action. If the CacheClusterId parameter is included, details for the specified cluster are returned. If the CacheClusterId parameter is omitted, details for up to MaxRecords (default 100) clusters are returned. The value for MaxRecords cannot be less than 20 or greater than 100.

The following code lists the details for my-cluster.

https://elasticache.us-west-2.amazonaws.com/ ?Action=DescribeCacheClusters &CacheClusterId=my-cluster &Version=2015-02-02 &SignatureVersion=4 &SignatureMethod=HmacSHA256 &Timestamp=20150202T192317Z &X-Amz-Credential=<credential>

The following code list the details for up to 25 clusters.

https://elasticache.us-west-2.amazonaws.com/ ?Action=DescribeCacheClusters &MaxRecords=25 &Version=2015-02-02 &SignatureVersion=4 &SignatureMethod=HmacSHA256 &Timestamp=20150202T192317Z &X-Amz-Credential=<credential>

For more information, see the ElastiCache API reference topic DescribeCacheClusters.