Skip to content

aws.rds.describe_global_clusters

Example SQL Queries

SELECT * FROM
aws.rds.describe_global_clusters;

Description

Returns information about Aurora global database clusters. This API supports pagination.

For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.

This action only applies to Aurora DB clusters.

Table Definition

Column NameColumn Data Type
filters Input Column

A filter that specifies one or more global database clusters to describe. This parameter is case-sensitive.

Currently, the only supported filter is region.

If used, the request returns information about any global cluster with at least one member (primary or secondary) in the specified Amazon Web Services Regions.

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 database cluster identifier. This identifier is the unique key that identifies a global database 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 database cluster.

VARCHAR
deletion_protection

The deletion protection setting for the new global database cluster.

BOOLEAN
engine

The Aurora database engine used by the global database cluster.

VARCHAR
engine_lifecycle_support

The life cycle type for the global cluster.

For more information, see CreateGlobalCluster.

VARCHAR
engine_version

Indicates the database engine version.

VARCHAR
failover_state

A data object containing all properties for the current state of an in-process or pending switchover or failover process for this global cluster (Aurora global database). This object is empty unless the SwitchoverGlobalCluster or FailoverGlobalCluster operation was called on this global cluster.

STRUCT(
"status" VARCHAR,
"from_db_cluster_arn" VARCHAR,
"to_db_cluster_arn" VARCHAR,
"is_data_loss_allowed" BOOLEAN
)
Show child fields
failover_state.from_db_cluster_arn

The Amazon Resource Name (ARN) of the Aurora DB cluster that is currently being demoted, and which is associated with this state.

failover_state.is_data_loss_allowed

Indicates whether the operation is a global switchover or a global failover. If data loss is allowed, then the operation is a global failover. Otherwise, it's a switchover.

failover_state.status

The current status of the global cluster. Possible values are as follows:

  • pending – The service received a request to switch over or fail over the global cluster. The global cluster's primary DB cluster and the specified secondary DB cluster are being verified before the operation starts.

  • failing-over – Aurora is promoting the chosen secondary Aurora DB cluster to become the new primary DB cluster to fail over the global cluster.

  • cancelling – The request to switch over or fail over the global cluster was cancelled and the primary Aurora DB cluster and the selected secondary Aurora DB cluster are returning to their previous states.

  • switching-over – This status covers the range of Aurora internal operations that take place during the switchover process, such as demoting the primary Aurora DB cluster, promoting the secondary Aurora DB cluster, and synchronizing replicas.

failover_state.to_db_cluster_arn

The Amazon Resource Name (ARN) of the Aurora DB cluster that is currently being promoted, and which is associated with this state.

global_cluster_arn

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

VARCHAR
global_cluster_members

The list of primary and secondary clusters within the global database cluster.

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

The Amazon Resource Name (ARN) for each Aurora DB cluster in the global cluster.

global_cluster_members[].global_write_forwarding_status

The status of write forwarding for a secondary cluster in the global cluster.

global_cluster_members[].is_writer

Indicates whether the Aurora DB cluster is the primary cluster (that is, has read-write capability) for the global cluster with which it is associated.

global_cluster_members[].readers[]
global_cluster_members[].synchronization_status

The status of synchronization of each Aurora DB cluster in the global cluster.

global_cluster_resource_id

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

VARCHAR
status

Specifies the current state of this global database cluster.

VARCHAR
storage_encrypted

The storage encryption setting for the global database cluster.

BOOLEAN