CmdID / aws / aws memorydb

aws memorydb describe-clusters

Returns information about all provisioned clusters if no cluster identifier is specified, or about a specific cluster if a cluster name is supplied. AWS CLI reference

1 example 4 options Its page in the AWS CLI reference

Examples

from aws-cli, each command read by CmdID

To return a list of clusters

The following describe-clusters example returns a list of clusters.

aws memorydb describe-clustersIdentify

Its output, shortened

{
    "Clusters": [
        {
                "Name": "my-cluster",
                "Status": "available",
                "NumberOfShards": 2,
                "ClusterEndpoint": {
                    "Address": "clustercfg.my-cluster.llru6f.memorydb.us-west-2.amazonaws.com",
                    "Port": 6379
                },
                "NodeType": "db.r6g.large",
                "EngineVersion": "6.2",
                "EnginePatchVersion": "6.2.6",
                "ParameterGroupName": "default.memorydb-redis6",
                "ParameterGroupStatus": "in-sync",
                "SecurityGroups": [
                    {
                        "SecurityGroupId": "sg-0a1434xxxxxc9fae",
                        "Status": "active"
                    }
                ],
                "SubnetGroupName": "pat-sg",
                "TLSEnabled": true,
                "ARN": "arn:aws:memorydb:us-west-2:49165xxxxxx:cluster/my-cluster",
                "SnapshotRetentionLimit": 0,
                "MaintenanceWindow": "wed:03:00-wed:04:00",
                "SnapshotWindow": "04:30-05:30",
                "ACLName": "my-acl",
                "AutoMinorVersionUpgrade": true
        }
… 2 more lines

For more information, see Managing clusters in the MemoryDB User Guide.

Options

4 in the AWS CLI reference

--cluster-nameThe name of the cluster.

--max-resultsThe maximum number of records to include in the response.

--next-tokenAn optional argument to pass in case the total number of records exceeds the value of MaxResults.

--show-shard-detailsAn optional flag that can be included in the request to retrieve information about the individual shard(s).