AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . memorydb ]

describe-clusters

Description

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

See also: AWS API Documentation

describe-clusters is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: Clusters

Synopsis

  describe-clusters
[--cluster-name <value>]
[--show-shard-details | --no-show-shard-details]
[--cli-input-json <value>]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--cluster-name (string)

The name of the cluster

--show-shard-details | --no-show-shard-details (boolean)

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

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command's output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command's output. If the total number of items available is more than the value specified, a NextToken is provided in the command's output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Examples

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal's quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To return a list of clusters

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

aws memorydb describe-clusters

Output:

{
    "Clusters": [
        {
                "Name": "my-cluster",
                "Status": "available",
                "NumberOfShards": 2,
                "ClusterEndpoint": {
                    "Address": "clustercfg.my-cluster.llru6f.memorydb.us-east-1.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-east-1:49165xxxxxx:cluster/my-cluster",
                "SnapshotRetentionLimit": 0,
                "MaintenanceWindow": "wed:03:00-wed:04:00",
                "SnapshotWindow": "04:30-05:30",
                "ACLName": "my-acl",
                "AutoMinorVersionUpgrade": true
        }
    ]
}

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

Output

NextToken -> (string)

An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

Clusters -> (list)

A list of clusters

(structure)

Contains all of the attributes of a specific cluster.

Name -> (string)

The user-supplied name of the cluster. This identifier is a unique key that identifies a cluster.

Description -> (string)

A description of the cluster

Status -> (string)

The status of the cluster. For example, Available, Updating, Creating.

PendingUpdates -> (structure)

A group of settings that are currently being applied.

Resharding -> (structure)

The status of an online resharding operation.

SlotMigration -> (structure)

The status of the online resharding slot migration

ProgressPercentage -> (double)

The percentage of the slot migration that is complete.

ACLs -> (structure)

A list of ACLs associated with the cluster that are being updated

ACLToApply -> (string)

A list of ACLs pending to be applied.

ServiceUpdates -> (list)

A list of service updates being applied to the cluster

(structure)

Update action that has yet to be processed for the corresponding apply/stop request

ServiceUpdateName -> (string)

The unique ID of the service update

Status -> (string)

The status of the service update

NumberOfShards -> (integer)

The number of shards in the cluster

Shards -> (list)

A list of shards that are members of the cluster.

(structure)

Represents a collection of nodes in a cluster. One node in the node group is the read/write primary node. All the other nodes are read-only Replica nodes.

Name -> (string)

The name of the shard

Status -> (string)

The current state of this replication group - creating, available, modifying, deleting.

Slots -> (string)

The keyspace for this shard.

Nodes -> (list)

A list containing information about individual nodes within the shard

(structure)

Represents an individual node within a cluster. Each node runs its own instance of the cluster's protocol-compliant caching software.

Name -> (string)

The node identifier. A node name is a numeric identifier (0001, 0002, etc.). The combination of cluster name, shard name and node name uniquely identifies every node used in a customer's Amazon account.

Status -> (string)

The status of the service update on the node

AvailabilityZone -> (string)

The Availability Zone in which the node resides

CreateTime -> (timestamp)

The date and time when the node was created.

Endpoint -> (structure)

The hostname for connecting to this node.

Address -> (string)

The DNS hostname of the node.

Port -> (integer)

The port number that the engine is listening on.

NumberOfNodes -> (integer)

The number of nodes in the shard

AvailabilityMode -> (string)

Indicates if the cluster has a Multi-AZ configuration (multiaz) or not (singleaz).

ClusterEndpoint -> (structure)

The cluster's configuration endpoint

Address -> (string)

The DNS hostname of the node.

Port -> (integer)

The port number that the engine is listening on.

NodeType -> (string)

The cluster's node type

Engine -> (string)

The Redis OSS or Valkey engine used by the cluster.

EngineVersion -> (string)

The Redis engine version used by the cluster

EnginePatchVersion -> (string)

The engine patch version used by the cluster

ParameterGroupName -> (string)

The name of the parameter group used by the cluster

ParameterGroupStatus -> (string)

The status of the parameter group used by the cluster, for example 'active' or 'applying'.

SecurityGroups -> (list)

A list of security groups used by the cluster

(structure)

Represents a single security group and its status.

SecurityGroupId -> (string)

The identifier of the security group.

Status -> (string)

The status of the security group membership. The status changes whenever a security group is modified, or when the security groups assigned to a cluster are modified.

SubnetGroupName -> (string)

The name of the subnet group used by the cluster

TLSEnabled -> (boolean)

A flag to indicate if In-transit encryption is enabled

KmsKeyId -> (string)

The ID of the KMS key used to encrypt the cluster

ARN -> (string)

The Amazon Resource Name (ARN) of the cluster.

SnsTopicArn -> (string)

The Amazon Resource Name (ARN) of the SNS notification topic

SnsTopicStatus -> (string)

The SNS topic must be in Active status to receive notifications

SnapshotRetentionLimit -> (integer)

The number of days for which MemoryDB retains automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.

MaintenanceWindow -> (string)

Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.

SnapshotWindow -> (string)

The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard. Example: 05:00-09:00 If you do not specify this parameter, MemoryDB automatically chooses an appropriate time range.

ACLName -> (string)

The name of the Access Control List associated with this cluster.

AutoMinorVersionUpgrade -> (boolean)

When set to true, the cluster will automatically receive minor engine version upgrades after launch.

DataTiering -> (string)

Enables data tiering. Data tiering is only supported for clusters using the r6gd node type. This parameter must be set when using r6gd nodes. For more information, see Data tiering .