Skip to content
AWS for Query.Farm

aws.docdb.describe_global_clusters

Example SQL Queries

SELECT * FROM
aws.docdb.describe_global_clusters;

Description

Returns information about Amazon DocumentDB global clusters. This API supports pagination.

This action only applies to Amazon DocumentDB clusters.

Table Definition

Column NameColumn Data Type
filters Input Column

A filter that specifies one or more global DB clusters to describe.

Supported filters: db-cluster-id accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list will only include information about the clusters identified by these ARNs.

STRUCT(
    "name" VARCHAR,
    "values" VARCHAR[]
)[]
Show child fields
filters[]
Show child fields
filters[].name

The name of the filter. Filter names are case sensitive.

filters[].values[]
global_cluster_identifier Input Column

Contains a user-supplied global cluster identifier. This identifier is the unique key that identifies a global cluster. 

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
database_name

The default database name within the new global cluster.

VARCHAR
deletion_protection

The deletion protection setting for the new global cluster.

BOOLEAN
engine

The Amazon DocumentDB database engine used by the global cluster. 

VARCHAR
engine_version

Indicates the database engine version.

VARCHAR
global_cluster_arn

The Amazon Resource Name (ARN) for the global cluster.

VARCHAR
global_cluster_members

The list of cluster IDs for secondary clusters within the global cluster. Currently limited to one item. 

STRUCT(
    "db_cluster_arn" VARCHAR,
    "readers" VARCHAR[],
    "is_writer" BOOLEAN
)[]
Show child fields
global_cluster_members[]
Show child fields
global_cluster_members[].db_cluster_arn

The Amazon Resource Name (ARN) for each Amazon DocumentDB cluster.

global_cluster_members[].is_writer

Specifies whether the Amazon DocumentDB cluster is the primary cluster (that is, has read-write capability) for the Amazon DocumentDB global cluster with which it is associated.

global_cluster_members[].readers[]
global_cluster_resource_id

The Amazon Web Services Region-unique, immutable identifier for the global database cluster. This identifier is found in CloudTrail log entries whenever the KMS customer master key (CMK) for the cluster is accessed. 

VARCHAR
status

Specifies the current state of this global cluster.

VARCHAR
storage_encrypted

The storage encryption setting for the global cluster.

BOOLEAN