Skip to content
AWS for Query.Farm

aws.elasticache.describe_global_replication_groups

Example SQL Queries

SELECT * FROM
aws.elasticache.describe_global_replication_groups;

Description

Returns information about a particular global replication group. If no identifier is specified, returns information about all Global datastores.

Table Definition

Column NameColumn Data Type
global_replication_group_id Input Column

The name of the Global datastore

VARCHAR
show_member_info Input Column

Returns the list of members that comprise the Global datastore.

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.

_aws_region Input Column

The AWS region to use.

VARCHAR
arn

The ARN (Amazon Resource Name) of the global 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 replication group is created. To enable encryption at rest on a replication group you must set AtRestEncryptionEnabled to true when you create the replication group.

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

BOOLEAN
auth_token_enabled

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

Default: false 

BOOLEAN
cache_node_type

The cache node type of the Global datastore

VARCHAR
cluster_enabled

A flag that indicates whether the Global datastore is cluster enabled.

BOOLEAN
engine

The Elasticache engine. For Redis OSS only.

VARCHAR
engine_version

The Elasticache (Redis OSS) engine version.

VARCHAR
global_node_groups

Indicates the slot configuration and global identifier for each slice group.

STRUCT(
    "global_node_group_id" VARCHAR,
    "slots" VARCHAR
)[]
Show child fields
global_node_groups[]
Show child fields
global_node_groups[].global_node_group_id

The name of the global node group

global_node_groups[].slots

The keyspace for this node group

global_replication_group_description

The optional description of the Global datastore

VARCHAR
members

The replication groups that comprise the Global datastore.

STRUCT(
    "replication_group_id" VARCHAR,
    "replication_group_region" VARCHAR,
    "role" VARCHAR,
    "automatic_failover" VARCHAR,
    "status" VARCHAR
)[]
Show child fields
members[]
Show child fields
members[].automatic_failover

Indicates whether automatic failover is enabled for the replication group.

members[].replication_group_id

The replication group id of the Global datastore member.

members[].replication_group_region

The Amazon region of the Global datastore member.

members[].role

Indicates the role of the replication group, primary or secondary.

members[].status

The status of the membership of the replication group.

status

The status of the Global datastore

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.

BOOLEAN