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 . elasticache ]
Returns information about cluster or replication group snapshots. By default, DescribeSnapshots
lists all of your snapshots; it can optionally describe a single snapshot, or just the snapshots associated with a particular cache cluster.
See also: AWS API Documentation
describe-snapshots
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: Snapshots
describe-snapshots
[--replication-group-id <value>]
[--cache-cluster-id <value>]
[--snapshot-name <value>]
[--snapshot-source <value>]
[--show-node-group-config | --no-show-node-group-config]
[--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>]
--replication-group-id
(string)
A user-supplied replication group identifier. If this parameter is specified, only snapshots associated with that specific replication group are described.
--cache-cluster-id
(string)
A user-supplied cluster identifier. If this parameter is specified, only snapshots associated with that specific cluster are described.
--snapshot-name
(string)
A user-supplied name of the snapshot. If this parameter is specified, only this snapshot are described.
--snapshot-source
(string)
If set tosystem
, the output shows snapshots that were automatically created by ElastiCache. If set touser
the output shows snapshots that were manually created. If omitted, the output shows both automatically and manually created snapshots.
--show-node-group-config
| --no-show-node-group-config
(boolean)
A Boolean value which if true, the node group (shard) configuration is included in the snapshot description.
--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 theNextToken
value in thestarting-token
argument of a subsequent command. Do not use theNextToken
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.
--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.
--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.
--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.
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 describe snapshots
The following ''describe-snapshots'' example returns information about your cluster or replication group snapshots.
aws elasticache describe-snapshots
Output:
{
"Snapshots": [
{
"SnapshotName": "automatic.my-cluster2-002-2019-12-05-06-38",
"CacheClusterId": "my-cluster2-002",
"SnapshotStatus": "available",
"SnapshotSource": "automated",
"CacheNodeType": "cache.r5.large",
"Engine": "redis",
"EngineVersion": "5.0.5",
"NumCacheNodes": 1,
"PreferredAvailabilityZone": "us-west-2a",
"CacheClusterCreateTime": "2019-11-26T01:22:52.396Z",
"PreferredMaintenanceWindow": "mon:17:30-mon:18:30",
"TopicArn": "arn:aws:sns:us-west-2:xxxxxxxxx52:My_Topic",
"Port": 6379,
"CacheParameterGroupName": "default.redis5.0",
"CacheSubnetGroupName": "kxkxk",
"VpcId": "vpc-a3e97cdb",
"AutoMinorVersionUpgrade": true,
"SnapshotRetentionLimit": 1,
"SnapshotWindow": "06:30-07:30",
"NodeSnapshots": [
{
"CacheNodeId": "0001",
"CacheSize": "5 MB",
"CacheNodeCreateTime": "2019-11-26T01:22:52.396Z",
"SnapshotCreateTime": "2019-12-05T06:38:23Z"
}
]
},
{
"SnapshotName": "myreplica-backup",
"CacheClusterId": "myreplica",
"SnapshotStatus": "available",
"SnapshotSource": "manual",
"CacheNodeType": "cache.r5.large",
"Engine": "redis",
"EngineVersion": "5.0.5",
"NumCacheNodes": 1,
"PreferredAvailabilityZone": "us-west-2a",
"CacheClusterCreateTime": "2019-11-26T00:14:52.439Z",
"PreferredMaintenanceWindow": "sat:10:00-sat:11:00",
"TopicArn": "arn:aws:sns:us-west-2:xxxxxxxxxx152:My_Topic",
"Port": 6379,
"CacheParameterGroupName": "default.redis5.0",
"CacheSubnetGroupName": "kxkxk",
"VpcId": "vpc-a3e97cdb",
"AutoMinorVersionUpgrade": true,
"SnapshotRetentionLimit": 0,
"SnapshotWindow": "09:00-10:00",
"NodeSnapshots": [
{
"CacheNodeId": "0001",
"CacheSize": "5 MB",
"CacheNodeCreateTime": "2019-11-26T00:14:52.439Z",
"SnapshotCreateTime": "2019-11-26T00:25:01Z"
}
]
},
{
"SnapshotName": "my-cluster",
"CacheClusterId": "my-cluster-003",
"SnapshotStatus": "available",
"SnapshotSource": "manual",
"CacheNodeType": "cache.r5.large",
"Engine": "redis",
"EngineVersion": "5.0.5",
"NumCacheNodes": 1,
"PreferredAvailabilityZone": "us-west-2a",
"CacheClusterCreateTime": "2019-11-25T23:56:17.186Z",
"PreferredMaintenanceWindow": "sat:10:00-sat:11:00",
"TopicArn": "arn:aws:sns:us-west-2:xxxxxxxxxx152:My_Topic",
"Port": 6379,
"CacheParameterGroupName": "default.redis5.0",
"CacheSubnetGroupName": "kxkxk",
"VpcId": "vpc-a3e97cdb",
"AutoMinorVersionUpgrade": true,
"SnapshotRetentionLimit": 0,
"SnapshotWindow": "09:00-10:00",
"NodeSnapshots": [
{
"CacheNodeId": "0001",
"CacheSize": "5 MB",
"CacheNodeCreateTime": "2019-11-25T23:56:17.186Z",
"SnapshotCreateTime": "2019-11-26T03:08:33Z"
}
]
}
]
}
For more information, see Backup and Restore for ElastiCache for Redis in the Elasticache User Guide.
Marker -> (string)
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 byMaxRecords
.
Snapshots -> (list)
A list of snapshots. Each item in the list contains detailed information about one snapshot.
(structure)
Represents a copy of an entire Valkey or Redis OSS cluster as of the time when the snapshot was taken.
SnapshotName -> (string)
The name of a snapshot. For an automatic snapshot, the name is system-generated. For a manual snapshot, this is the user-provided name.ReplicationGroupId -> (string)
The unique identifier of the source replication group.ReplicationGroupDescription -> (string)
A description of the source replication group.CacheClusterId -> (string)
The user-supplied identifier of the source cluster.SnapshotStatus -> (string)
The status of the snapshot. Valid values:creating
|available
|restoring
|copying
|deleting
.SnapshotSource -> (string)
Indicates whether the snapshot is from an automatic backup (automated
) or was created manually (manual
).CacheNodeType -> (string)
The name of the compute and memory capacity node type for the source cluster.
The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.
General purpose:
- Current generation: M7g node types :
cache.m7g.large
,cache.m7g.xlarge
,cache.m7g.2xlarge
,cache.m7g.4xlarge
,cache.m7g.8xlarge
,cache.m7g.12xlarge
,cache.m7g.16xlarge
Note
For region availability, see Supported Node Types
M6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):
cache.m6g.large
,cache.m6g.xlarge
,cache.m6g.2xlarge
,cache.m6g.4xlarge
,cache.m6g.8xlarge
,cache.m6g.12xlarge
,cache.m6g.16xlarge
M5 node types:cache.m5.large
,cache.m5.xlarge
,cache.m5.2xlarge
,cache.m5.4xlarge
,cache.m5.12xlarge
,cache.m5.24xlarge
M4 node types:cache.m4.large
,cache.m4.xlarge
,cache.m4.2xlarge
,cache.m4.4xlarge
,cache.m4.10xlarge
T4g node types (available only for Redis OSS engine version 5.0.6 onward and Memcached engine version 1.5.16 onward):cache.t4g.micro
,cache.t4g.small
,cache.t4g.medium
T3 node types:cache.t3.micro
,cache.t3.small
,cache.t3.medium
T2 node types:cache.t2.micro
,cache.t2.small
,cache.t2.medium
- Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.) T1 node types:
cache.t1.micro
M1 node types:cache.m1.small
,cache.m1.medium
,cache.m1.large
,cache.m1.xlarge
M3 node types:cache.m3.medium
,cache.m3.large
,cache.m3.xlarge
,cache.m3.2xlarge
Compute optimized:
- Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.) C1 node types:
cache.c1.xlarge
Memory optimized:
- Current generation: R7g node types :
cache.r7g.large
,cache.r7g.xlarge
,cache.r7g.2xlarge
,cache.r7g.4xlarge
,cache.r7g.8xlarge
,cache.r7g.12xlarge
,cache.r7g.16xlarge
Note
For region availability, see Supported Node Types
R6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward):
cache.r6g.large
,cache.r6g.xlarge
,cache.r6g.2xlarge
,cache.r6g.4xlarge
,cache.r6g.8xlarge
,cache.r6g.12xlarge
,cache.r6g.16xlarge
R5 node types:cache.r5.large
,cache.r5.xlarge
,cache.r5.2xlarge
,cache.r5.4xlarge
,cache.r5.12xlarge
,cache.r5.24xlarge
R4 node types:cache.r4.large
,cache.r4.xlarge
,cache.r4.2xlarge
,cache.r4.4xlarge
,cache.r4.8xlarge
,cache.r4.16xlarge
- Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.) M2 node types:
cache.m2.xlarge
,cache.m2.2xlarge
,cache.m2.4xlarge
R3 node types:cache.r3.large
,cache.r3.xlarge
,cache.r3.2xlarge
,cache.r3.4xlarge
,cache.r3.8xlarge
Additional node type info
- All current generation instance types are created in Amazon VPC by default.
- Valkey or Redis OSS append-only files (AOF) are not supported for T1 or T2 instances.
- Valkey or Redis OSS Multi-AZ with automatic failover is not supported on T1 instances.
- The configuration variables
appendonly
andappendfsync
are not supported on Valkey, or on Redis OSS version 2.8.22 and later.Engine -> (string)
The name of the cache engine (memcached
orredis
) used by the source cluster.EngineVersion -> (string)
The version of the cache engine version that is used by the source cluster.NumCacheNodes -> (integer)
The number of cache nodes in the source cluster.
For clusters running Valkey or Redis OSS, this value must be 1. For clusters running Memcached, this value must be between 1 and 40.
PreferredAvailabilityZone -> (string)
The name of the Availability Zone in which the source cluster is located.PreferredOutpostArn -> (string)
The ARN (Amazon Resource Name) of the preferred outpost.CacheClusterCreateTime -> (timestamp)
The date and time when the source cluster was created.PreferredMaintenanceWindow -> (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.
Valid values for
ddd
are:
sun
mon
tue
wed
thu
fri
sat
Example:
sun:23:00-mon:01:30
TopicArn -> (string)
The Amazon Resource Name (ARN) for the topic used by the source cluster for publishing notifications.Port -> (integer)
The port number used by each cache nodes in the source cluster.CacheParameterGroupName -> (string)
The cache parameter group that is associated with the source cluster.CacheSubnetGroupName -> (string)
The name of the cache subnet group associated with the source cluster.VpcId -> (string)
The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group for the source cluster.AutoMinorVersionUpgrade -> (boolean)
If you are running Valkey 7.2 and above or Redis OSS engine version 6.0 and above, set this parameter to yes if you want to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions.SnapshotRetentionLimit -> (integer)
For an automatic snapshot, the number of days for which ElastiCache retains the snapshot before deleting it.
For manual snapshots, this field reflects the
SnapshotRetentionLimit
for the source cluster when the snapshot was created. This field is otherwise ignored: Manual snapshots do not expire, and can only be deleted using theDeleteSnapshot
operation.Important If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.SnapshotWindow -> (string)
The daily time range during which ElastiCache takes daily snapshots of the source cluster.NumNodeGroups -> (integer)
The number of node groups (shards) in this snapshot. When restoring from a snapshot, the number of node groups (shards) in the snapshot and in the restored replication group must be the same.AutomaticFailover -> (string)
Indicates the status of automatic failover for the source Valkey or Redis OSS replication group.NodeSnapshots -> (list)
A list of the cache nodes in the source cluster.
(structure)
Represents an individual cache node in a snapshot of a cluster.
CacheClusterId -> (string)
A unique identifier for the source cluster.NodeGroupId -> (string)
A unique identifier for the source node group (shard).CacheNodeId -> (string)
The cache node identifier for the node in the source cluster.NodeGroupConfiguration -> (structure)
The configuration for the source node group (shard).
NodeGroupId -> (string)
Either the ElastiCache supplied 4-digit id or a user supplied id for the node group these configuration values apply to.Slots -> (string)
A string that specifies the keyspace for a particular node group. Keyspaces range from 0 to 16,383. The string is in the format
startkey-endkey
.Example:
"0-3999"
ReplicaCount -> (integer)
The number of read replica nodes in this node group (shard).PrimaryAvailabilityZone -> (string)
The Availability Zone where the primary node of this node group (shard) is launched.ReplicaAvailabilityZones -> (list)
A list of Availability Zones to be used for the read replicas. The number of Availability Zones in this list must match the value of
ReplicaCount
orReplicasPerNodeGroup
if not specified.(string)
PrimaryOutpostArn -> (string)
The outpost ARN of the primary node.ReplicaOutpostArns -> (list)
The outpost ARN of the node replicas.
(string)
CacheSize -> (string)
The size of the cache on the source cache node.CacheNodeCreateTime -> (timestamp)
The date and time when the cache node was created in the source cluster.SnapshotCreateTime -> (timestamp)
The date and time when the source node's metadata and cache data set was obtained for the snapshot.KmsKeyId -> (string)
The ID of the KMS key used to encrypt the snapshot.ARN -> (string)
The ARN (Amazon Resource Name) of the snapshot.DataTiering -> (string)
Enables data tiering. Data tiering is only supported for replication groups using the r6gd node type. This parameter must be set to true when using r6gd nodes. For more information, see Data tiering .