Skip to content

aws.memorydb.describe_clusters

Example SQL Queries

SELECT * FROM
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.

Table Definition

Column NameColumn Data Type
cluster_name Input Column

The name of the cluster

VARCHAR
show_shard_details Input Column

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

BOOLEAN
_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.

acl_name

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

VARCHAR
arn

The Amazon Resource Name (ARN) of the cluster.

VARCHAR
auto_minor_version_upgrade

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

BOOLEAN
availability_mode

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

VARCHAR
cluster_endpoint

The cluster's configuration endpoint

STRUCT(
"address" VARCHAR,
"port" BIGINT
)
Show child fields
cluster_endpoint.address

The DNS hostname of the node.

cluster_endpoint.port

The port number that the engine is listening on.

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
description

A description of the cluster

VARCHAR
engine_patch_version

The Redis OSS engine patch version used by the cluster

VARCHAR
engine_version

The Redis OSS engine version used by the cluster

VARCHAR
kms_key_id

The ID of the KMS key used to encrypt the cluster

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

VARCHAR
name

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

VARCHAR
node_type

The cluster's node type

VARCHAR
number_of_shards

The number of shards in the cluster

BIGINT
parameter_group_name

The name of the parameter group used by the cluster

VARCHAR
parameter_group_status

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

VARCHAR
pending_updates

A group of settings that are currently being applied.

STRUCT(
"resharding" STRUCT(
"slot_migration" STRUCT(
"progress_percentage" DOUBLE
)
),
"ac_ls" STRUCT(
"acl_to_apply" VARCHAR
),
"service_updates" STRUCT(
"service_update_name" VARCHAR,
"status" VARCHAR
)[]
)
Show child fields
pending_updates.ac_ls

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

Show child fields
pending_updates.ac_ls.acl_to_apply

A list of ACLs pending to be applied.

pending_updates.resharding

The status of an online resharding operation.

Show child fields
pending_updates.resharding.slot_migration

The status of the online resharding slot migration

Show child fields
pending_updates.resharding.slot_migration.progress_percentage

The percentage of the slot migration that is complete.

pending_updates.service_updates[]
Show child fields
pending_updates.service_updates[].service_update_name

The unique ID of the service update

pending_updates.service_updates[].status

The status of the service update

security_groups

A list of security groups used by the cluster

STRUCT(
"security_group_id" VARCHAR,
"status" VARCHAR
)[]
Show child fields
security_groups[]
Show child fields
security_groups[].security_group_id

The identifier of the security group.

security_groups[].status

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.

shards

A list of shards that are members of the cluster.

STRUCT(
"name" VARCHAR,
"status" VARCHAR,
"slots" VARCHAR,
"nodes" STRUCT(
"name" VARCHAR,
"status" VARCHAR,
"availability_zone" VARCHAR,
"create_time" TIMESTAMP_S,
"endpoint" STRUCT(
"address" VARCHAR,
"port" BIGINT
)
)[],
"number_of_nodes" BIGINT
)[]
Show child fields
shards[]
Show child fields
shards[].name

The name of the shard

shards[].nodes[]
Show child fields
shards[].nodes[].availability_zone

The Availability Zone in which the node resides

shards[].nodes[].create_time

The date and time when the node was created.

shards[].nodes[].endpoint

The hostname for connecting to this node.

Show child fields
shards[].nodes[].endpoint.address

The DNS hostname of the node.

shards[].nodes[].endpoint.port

The port number that the engine is listening on.

shards[].nodes[].name

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.

shards[].nodes[].status

The status of the service update on the node

shards[].number_of_nodes

The number of nodes in the shard

shards[].slots

The keyspace for this shard.

shards[].status

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

snapshot_retention_limit

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.

BIGINT
snapshot_window

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.

VARCHAR
sns_topic_arn

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

VARCHAR
sns_topic_status

The SNS topic must be in Active status to receive notifications

VARCHAR
status

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

VARCHAR
subnet_group_name

The name of the subnet group used by the cluster

VARCHAR
tls_enabled

A flag to indicate if In-transit encryption is enabled

BOOLEAN