Skip to content
AWS for Query.Farm

aws.elasticache.describe_snapshots

Example SQL Queries

SELECT * FROM
aws.elasticache.describe_snapshots;

Description

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.

This operation is valid for Redis OSS only.

Table Definition

Column NameColumn Data Type
cache_cluster_id Input Column

The user-supplied identifier of the source cluster.

VARCHAR
replication_group_id Input Column

The unique identifier of the source replication group.

VARCHAR
show_node_group_config Input Column

A Boolean value which if true, the node group (shard) configuration is included in the snapshot description.

BOOLEAN
snapshot_name Input Column

The name of a snapshot. For an automatic snapshot, the name is system-generated. For a manual snapshot, this is the user-provided name.

VARCHAR
snapshot_source Input Column

Indicates whether the snapshot is from an automatic backup (automated) or was created manually (manual).

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
arn

The ARN (Amazon Resource Name) of the snapshot.

VARCHAR
auto_minor_version_upgrade

 If you are running Redis OSS engine version 6.0 or later, 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.  

BOOLEAN
automatic_failover

Indicates the status of automatic failover for the source Redis OSS replication group.

VARCHAR
cache_cluster_create_time

The date and time when the source cluster was created.

TIMESTAMP_S
cache_node_type

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

      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

      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.

  • Redis OSS append-only files (AOF) are not supported for T1 or T2 instances.

  • Redis OSS Multi-AZ with automatic failover is not supported on T1 instances.

  • Redis OSS configuration variables appendonly and appendfsync are not supported on Redis OSS version 2.8.22 and later.

VARCHAR
cache_parameter_group_name

The cache parameter group that is associated with the source cluster.

VARCHAR
cache_subnet_group_name

The name of the cache subnet group associated with the source cluster.

VARCHAR
data_tiering

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.

VARCHAR
engine

The name of the cache engine (memcached or redis) used by the source cluster.

VARCHAR
engine_version

The version of the cache engine version that is used by the source cluster.

VARCHAR
kms_key_id

The ID of the KMS key used to encrypt the snapshot.

VARCHAR
node_snapshots

A list of the cache nodes in the source cluster.

STRUCT(
    "cache_cluster_id" VARCHAR,
    "node_group_id" VARCHAR,
    "cache_node_id" VARCHAR,
    "node_group_configuration" STRUCT(
        "node_group_id" VARCHAR,
        "slots" VARCHAR,
        "replica_count" BIGINT,
        "primary_availability_zone" VARCHAR,
        "replica_availability_zones" VARCHAR[],
        "primary_outpost_arn" VARCHAR,
        "replica_outpost_arns" VARCHAR[]
    ),
    "cache_size" VARCHAR,
    "cache_node_create_time" TIMESTAMP_S,
    "snapshot_create_time" TIMESTAMP_S
)[]
Show child fields
node_snapshots[]
Show child fields
node_snapshots[].cache_cluster_id

A unique identifier for the source cluster.

node_snapshots[].cache_node_create_time

The date and time when the cache node was created in the source cluster.

node_snapshots[].cache_node_id

The cache node identifier for the node in the source cluster.

node_snapshots[].cache_size

The size of the cache on the source cache node.

node_snapshots[].node_group_configuration

The configuration for the source node group (shard).

Show child fields
node_snapshots[].node_group_configuration.node_group_id

Either the ElastiCache (Redis OSS) supplied 4-digit id or a user supplied id for the node group these configuration values apply to.

node_snapshots[].node_group_configuration.primary_availability_zone

The Availability Zone where the primary node of this node group (shard) is launched.

node_snapshots[].node_group_configuration.primary_outpost_arn

The outpost ARN of the primary node.

node_snapshots[].node_group_configuration.replica_availability_zones[]
node_snapshots[].node_group_configuration.replica_count

The number of read replica nodes in this node group (shard).

node_snapshots[].node_group_configuration.replica_outpost_arns[]
node_snapshots[].node_group_configuration.slots

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"

node_snapshots[].node_group_id

A unique identifier for the source node group (shard).

node_snapshots[].snapshot_create_time

The date and time when the source node's metadata and cache data set was obtained for the snapshot.

num_cache_nodes

The number of cache nodes in the source cluster.

For clusters running Redis OSS, this value must be 1. For clusters running Memcached, this value must be between 1 and 40.

BIGINT
num_node_groups

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.

BIGINT
port

The port number used by each cache nodes in the source cluster.

BIGINT
preferred_availability_zone

The name of the Availability Zone in which the source cluster is located.

VARCHAR
preferred_maintenance_window

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 

VARCHAR
preferred_outpost_arn

The ARN (Amazon Resource Name) of the preferred outpost.

VARCHAR
replication_group_description

A description of the source replication group.

VARCHAR
snapshot_retention_limit

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 the DeleteSnapshot operation.

Important If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.

BIGINT
snapshot_status

The status of the snapshot. Valid values: creating | available | restoring | copying | deleting.

VARCHAR
snapshot_window

The daily time range during which ElastiCache takes daily snapshots of the source cluster.

VARCHAR
topic_arn

The Amazon Resource Name (ARN) for the topic used by the source cluster for publishing notifications.

VARCHAR
vpc_id

The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group for the source cluster.

VARCHAR