Skip to content

aws.elasticache.describe_replication_groups

Example SQL Queries

SELECT * FROM
aws.elasticache.describe_replication_groups;

Description

Returns information about a particular replication group. If no identifier is specified, DescribeReplicationGroups returns information about all replication groups.

This operation is valid for Redis OSS only.

Table Definition

Column NameColumn Data Type
replication_group_id Input Column

The identifier for the replication group.

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 replication group.

VARCHAR
at_rest_encryption_enabled

A flag that enables encryption at-rest when set to true.

You cannot modify the value of AtRestEncryptionEnabled after the cluster is created. To enable encryption at-rest on a cluster you must set AtRestEncryptionEnabled to true when you create a cluster.

Required: Only available when creating a replication group in an Amazon VPC using Redis OSS version 3.2.6, 4.x or later.

Default: false

BOOLEAN
auth_token_enabled

A flag that enables using an AuthToken (password) when issuing Redis OSS commands.

Default: false

BOOLEAN
auth_token_last_modified_date

The date the auth token was last modified

TIMESTAMP_S
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 this Redis OSS replication group.

VARCHAR
cache_node_type

The name of the compute and memory capacity node type for each node in the replication group.

VARCHAR
cluster_enabled

A flag indicating whether or not this replication group is cluster enabled; i.e., whether its data can be partitioned across multiple shards (API/CLI: node groups).

Valid values: true | false

BOOLEAN
cluster_mode

Enabled or Disabled. To modify cluster mode from Disabled to Enabled, you must first set the cluster mode to Compatible. Compatible mode allows your Redis OSS clients to connect using both cluster mode enabled and cluster mode disabled. After you migrate all Redis OSS clients to use cluster mode enabled, you can then complete cluster mode configuration and set the cluster mode to Enabled.

VARCHAR
configuration_endpoint

The configuration endpoint for this replication group. Use the configuration endpoint to connect to this replication group.

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

The DNS hostname of the cache node.

configuration_endpoint.port

The port number that the cache engine is listening on.

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
description

The user supplied description of the replication group.

VARCHAR
global_replication_group_info

The name of the Global datastore and role of this replication group in the Global datastore.

STRUCT(
"global_replication_group_id" VARCHAR,
"global_replication_group_member_role" VARCHAR
)
Show child fields
global_replication_group_info.global_replication_group_id

The name of the Global datastore

global_replication_group_info.global_replication_group_member_role

The role of the replication group in a Global datastore. Can be primary or secondary.

ip_discovery

The network type you choose when modifying a cluster, either ipv4 | ipv6. IPv6 is supported for workloads using Redis OSS engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the Nitro system.

VARCHAR
kms_key_id

The ID of the KMS key used to encrypt the disk in the cluster.

VARCHAR
log_delivery_configurations

Returns the destination, format and type of the logs.

STRUCT(
"log_type" VARCHAR,
"destination_type" VARCHAR,
"destination_details" STRUCT(
"cloud_watch_logs_details" STRUCT(
"log_group" VARCHAR
),
"kinesis_firehose_details" STRUCT(
"delivery_stream" VARCHAR
)
),
"log_format" VARCHAR,
"status" VARCHAR,
"message" VARCHAR
)[]
Show child fields
log_delivery_configurations[]
Show child fields
log_delivery_configurations[].destination_details

Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.

Show child fields
log_delivery_configurations[].destination_details.cloud_watch_logs_details

The configuration details of the CloudWatch Logs destination.

Show child fields
log_delivery_configurations[].destination_details.cloud_watch_logs_details.log_group

The name of the CloudWatch Logs log group.

log_delivery_configurations[].destination_details.kinesis_firehose_details

The configuration details of the Kinesis Data Firehose destination.

Show child fields
log_delivery_configurations[].destination_details.kinesis_firehose_details.delivery_stream

The name of the Kinesis Data Firehose delivery stream.

log_delivery_configurations[].destination_type

Returns the destination type, either cloudwatch-logs or kinesis-firehose.

log_delivery_configurations[].log_format

Returns the log format, either JSON or TEXT.

log_delivery_configurations[].log_type

Refers to slow-log or engine-log.

log_delivery_configurations[].message

Returns an error message for the log delivery configuration.

log_delivery_configurations[].status

Returns the log delivery configuration status. Values are one of enabling | disabling | modifying | active | error

member_clusters

The names of all the cache clusters that are part of this replication group.

VARCHAR[]
Show child fields
member_clusters[]
member_clusters_outpost_arns

The outpost ARNs of the replication group's member clusters.

VARCHAR[]
Show child fields
member_clusters_outpost_arns[]
multi_az

A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more information, see Minimizing Downtime: Multi-AZ

VARCHAR
network_type

Must be either ipv4 | ipv6 | dual_stack. IPv6 is supported for workloads using Redis OSS engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the Nitro system.

VARCHAR
node_groups

A list of node groups in this replication group. For Redis OSS (cluster mode disabled) replication groups, this is a single-element list. For Redis OSS (cluster mode enabled) replication groups, the list contains an entry for each node group (shard).

STRUCT(
"node_group_id" VARCHAR,
"status" VARCHAR,
"primary_endpoint" STRUCT(
"address" VARCHAR,
"port" BIGINT
),
"reader_endpoint" STRUCT(
"address" VARCHAR,
"port" BIGINT
),
"slots" VARCHAR,
"node_group_members" STRUCT(
"cache_cluster_id" VARCHAR,
"cache_node_id" VARCHAR,
"read_endpoint" STRUCT(
"address" VARCHAR,
"port" BIGINT
),
"preferred_availability_zone" VARCHAR,
"preferred_outpost_arn" VARCHAR,
"current_role" VARCHAR
)[]
)[]
Show child fields
node_groups[]
Show child fields
node_groups[].node_group_id

The identifier for the node group (shard). A Redis OSS (cluster mode disabled) replication group contains only 1 node group; therefore, the node group ID is 0001. A Redis OSS (cluster mode enabled) replication group contains 1 to 90 node groups numbered 0001 to 0090. Optionally, the user can provide the id for a node group.

node_groups[].node_group_members[]
Show child fields
node_groups[].node_group_members[].cache_cluster_id

The ID of the cluster to which the node belongs.

node_groups[].node_group_members[].cache_node_id

The ID of the node within its cluster. A node ID is a numeric identifier (0001, 0002, etc.).

node_groups[].node_group_members[].current_role

The role that is currently assigned to the node - primary or replica. This member is only applicable for Redis OSS (cluster mode disabled) replication groups.

node_groups[].node_group_members[].preferred_availability_zone

The name of the Availability Zone in which the node is located.

node_groups[].node_group_members[].preferred_outpost_arn

The outpost ARN of the node group member.

node_groups[].node_group_members[].read_endpoint

The information required for client programs to connect to a node for read operations. The read endpoint is only applicable on Redis OSS (cluster mode disabled) clusters.

Show child fields
node_groups[].node_group_members[].read_endpoint.address

The DNS hostname of the cache node.

node_groups[].node_group_members[].read_endpoint.port

The port number that the cache engine is listening on.

node_groups[].primary_endpoint

The endpoint of the primary node in this node group (shard).

Show child fields
node_groups[].primary_endpoint.address

The DNS hostname of the cache node.

node_groups[].primary_endpoint.port

The port number that the cache engine is listening on.

node_groups[].reader_endpoint

The endpoint of the replica nodes in this node group (shard). This value is read-only.

Show child fields
node_groups[].reader_endpoint.address

The DNS hostname of the cache node.

node_groups[].reader_endpoint.port

The port number that the cache engine is listening on.

node_groups[].slots

The keyspace for this node group (shard).

node_groups[].status

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

pending_modified_values

A group of settings to be applied to the replication group, either immediately or during the next maintenance window.

STRUCT(
"primary_cluster_id" VARCHAR,
"automatic_failover_status" VARCHAR,
"resharding" STRUCT(
"slot_migration" STRUCT(
"progress_percentage" DOUBLE
)
),
"auth_token_status" VARCHAR,
"user_groups" STRUCT(
"user_group_ids_to_add" VARCHAR[],
"user_group_ids_to_remove" VARCHAR[]
),
"log_delivery_configurations" STRUCT(
"log_type" VARCHAR,
"destination_type" VARCHAR,
"destination_details" STRUCT(
"cloud_watch_logs_details" STRUCT(
"log_group" VARCHAR
),
"kinesis_firehose_details" STRUCT(
"delivery_stream" VARCHAR
)
),
"log_format" VARCHAR
)[],
"transit_encryption_enabled" BOOLEAN,
"transit_encryption_mode" VARCHAR,
"cluster_mode" VARCHAR
)
Show child fields
pending_modified_values.auth_token_status

The auth token status

pending_modified_values.automatic_failover_status

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

pending_modified_values.cluster_mode

Enabled or Disabled. To modify cluster mode from Disabled to Enabled, you must first set the cluster mode to Compatible. Compatible mode allows your Redis OSS clients to connect using both cluster mode enabled and cluster mode disabled. After you migrate all Redis OSS clients to use cluster mode enabled, you can then complete cluster mode configuration and set the cluster mode to Enabled.

pending_modified_values.log_delivery_configurations[]
Show child fields
pending_modified_values.log_delivery_configurations[].destination_details

Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.

Show child fields
pending_modified_values.log_delivery_configurations[].destination_details.cloud_watch_logs_details

The configuration details of the CloudWatch Logs destination.

Show child fields
pending_modified_values.log_delivery_configurations[].destination_details.cloud_watch_logs_details.log_group

The name of the CloudWatch Logs log group.

pending_modified_values.log_delivery_configurations[].destination_details.kinesis_firehose_details

The configuration details of the Kinesis Data Firehose destination.

Show child fields
pending_modified_values.log_delivery_configurations[].destination_details.kinesis_firehose_details.delivery_stream

The name of the Kinesis Data Firehose delivery stream.

pending_modified_values.log_delivery_configurations[].destination_type

Returns the destination type, either CloudWatch Logs or Kinesis Data Firehose.

pending_modified_values.log_delivery_configurations[].log_format

Returns the log format, either JSON or TEXT

pending_modified_values.log_delivery_configurations[].log_type

Refers to slow-log or engine-log..

pending_modified_values.primary_cluster_id

The primary cluster ID that is applied immediately (if --apply-immediately was specified), or during the next maintenance window.

pending_modified_values.resharding

The status of an online resharding operation.

Show child fields
pending_modified_values.resharding.slot_migration

Represents the progress of an online resharding operation.

Show child fields
pending_modified_values.resharding.slot_migration.progress_percentage

The percentage of the slot migration that is complete.

pending_modified_values.transit_encryption_enabled

A flag that enables in-transit encryption when set to true.

pending_modified_values.transit_encryption_mode

A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.

pending_modified_values.user_groups

The user group being modified.

Show child fields
pending_modified_values.user_groups.user_group_ids_to_add[]
pending_modified_values.user_groups.user_group_ids_to_remove[]
replication_group_create_time

The date and time when the cluster was created.

TIMESTAMP_S
snapshot_retention_limit

The number of days for which ElastiCache retains automatic cluster 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.

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

BIGINT
snapshot_window

The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).

Example: 05:00-09:00

If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.

This parameter is only valid if the Engine parameter is redis.

VARCHAR
snapshotting_cluster_id

The cluster ID that is used as the daily snapshot source for the replication group.

VARCHAR
status

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

VARCHAR
transit_encryption_enabled

A flag that enables in-transit encryption when set to true.

Required: Only available when creating a replication group in an Amazon VPC using Redis OSS version 3.2.6, 4.x or later.

Default: false

BOOLEAN
transit_encryption_mode

A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.

VARCHAR
user_group_ids

The ID of the user group associated to the replication group.

VARCHAR[]
Show child fields
user_group_ids[]