Skip to content

aws.memorydb.describe_snapshots

Example SQL Queries

SELECT * FROM
aws.memorydb.describe_snapshots;

Description

Returns information about cluster snapshots. By default, DescribeSnapshots lists all of your snapshots; it can optionally describe a single snapshot, or just the snapshots associated with a particular cluster.

Table Definition

Column NameColumn Data Type
cluster_name Input Column

A user-supplied cluster identifier. If this parameter is specified, only snapshots associated with that specific cluster are described.

VARCHAR
show_detail Input Column

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

BOOLEAN
snapshot_name Input Column

A user-supplied name of the snapshot. If this parameter is specified, only this named snapshot is described.

VARCHAR
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.

arn

The ARN (Amazon Resource Name) of the snapshot.

VARCHAR
cluster_configuration

The configuration of the cluster from which the snapshot was taken

STRUCT(
"name" VARCHAR,
"description" VARCHAR,
"node_type" VARCHAR,
"engine_version" VARCHAR,
"maintenance_window" VARCHAR,
"topic_arn" VARCHAR,
"port" BIGINT,
"parameter_group_name" VARCHAR,
"subnet_group_name" VARCHAR,
"vpc_id" VARCHAR,
"snapshot_retention_limit" BIGINT,
"snapshot_window" VARCHAR,
"num_shards" BIGINT,
"shards" STRUCT(
"name" VARCHAR,
"configuration" STRUCT(
"slots" VARCHAR,
"replica_count" BIGINT
),
"size" VARCHAR,
"snapshot_creation_time" TIMESTAMP_S
)[]
)
Show child fields
cluster_configuration.description

The description of the cluster configuration

cluster_configuration.engine_version

The Redis OSS engine version used by the cluster

cluster_configuration.maintenance_window

The specified maintenance window for the cluster

cluster_configuration.name

The name of the cluster

cluster_configuration.node_type

The node type used for the cluster

cluster_configuration.num_shards

The number of shards in the cluster

cluster_configuration.parameter_group_name

The name of parameter group used by the cluster

cluster_configuration.port

The port used by the cluster

cluster_configuration.shards[]
Show child fields
cluster_configuration.shards[].configuration

The configuration details of the shard

Show child fields
cluster_configuration.shards[].configuration.replica_count

The number of read replica nodes in this shard.

cluster_configuration.shards[].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.

cluster_configuration.shards[].name

The name of the shard

cluster_configuration.shards[].size

The size of the shard's snapshot

cluster_configuration.shards[].snapshot_creation_time

The date and time that the shard's snapshot was created

cluster_configuration.snapshot_retention_limit

The snapshot retention limit set by the cluster

cluster_configuration.snapshot_window

The snapshot window set by the cluster

cluster_configuration.subnet_group_name

The name of the subnet group used by the cluster

cluster_configuration.topic_arn

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

cluster_configuration.vpc_id

The ID of the VPC the cluster belongs to

data_tiering

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.

VARCHAR
kms_key_id

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

VARCHAR
name

The name of the snapshot

VARCHAR
status

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

VARCHAR