Skip to content
AWS for Query.Farm

aws.docdb.describe_db_clusters

Example SQL Queries

SELECT * FROM
aws.docdb.describe_db_clusters;

Description

Returns information about provisioned Amazon DocumentDB clusters. This API operation supports pagination. For certain management features such as cluster and instance lifecycle management, Amazon DocumentDB leverages operational technology that is shared with Amazon RDS and Amazon Neptune. Use the filterName=engine,Values=docdb filter parameter to return only Amazon DocumentDB clusters.

Table Definition

Column NameColumn Data Type
db_cluster_identifier Input Column

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

VARCHAR
filters Input Column

A filter that specifies one or more clusters to describe.

Supported filters:

  • db-cluster-id - Accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list only includes 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[]
_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
associated_roles

Provides a list of the Identity and Access Management (IAM) roles that are associated with the cluster. (IAM) roles that are associated with a cluster grant permission for the cluster to access other Amazon Web Services services on your behalf.

STRUCT(
    "role_arn" VARCHAR,
    "status" VARCHAR
)[]
Show child fields
associated_roles[]
Show child fields
associated_roles[].role_arn

The Amazon Resource Name (ARN) of the IAMrole that is associated with the DB cluster.

associated_roles[].status

Describes the state of association between the IAMrole and the cluster. The Status property returns one of the following values:

  • ACTIVE - The IAMrole ARN is associated with the cluster and can be used to access other Amazon Web Services services on your behalf.

  • PENDING - The IAMrole ARN is being associated with the cluster.

  • INVALID - The IAMrole ARN is associated with the cluster, but the cluster cannot assume the IAMrole to access other Amazon Web Services services on your behalf.

availability_zones

Provides the list of Amazon EC2 Availability Zones that instances in the cluster can be created in.

VARCHAR[]
Show child fields
availability_zones[]
backup_retention_period

Specifies the number of days for which automatic snapshots are retained.

BIGINT
clone_group_id

Identifies the clone group to which the DB cluster is associated.

VARCHAR
cluster_create_time

Specifies the time when the cluster was created, in Universal Coordinated Time (UTC).

TIMESTAMP_S
db_cluster_arn

The Amazon Resource Name (ARN) for the cluster.

VARCHAR
db_cluster_members

Provides the list of instances that make up the cluster.

STRUCT(
    "db_instance_identifier" VARCHAR,
    "is_cluster_writer" BOOLEAN,
    "db_cluster_parameter_group_status" VARCHAR,
    "promotion_tier" BIGINT
)[]
Show child fields
db_cluster_members[]
Show child fields
db_cluster_members[].db_cluster_parameter_group_status

Specifies the status of the cluster parameter group for this member of the DB cluster.

db_cluster_members[].db_instance_identifier

Specifies the instance identifier for this member of the cluster.

db_cluster_members[].is_cluster_writer

A value that is true if the cluster member is the primary instance for the cluster and false otherwise.

db_cluster_members[].promotion_tier

A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.

db_cluster_parameter_group

Specifies the name of the cluster parameter group for the cluster.

VARCHAR
db_cluster_resource_id

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

VARCHAR
db_subnet_group

Specifies information on the subnet group that is associated with the cluster, including the name, description, and subnets in the subnet group.

VARCHAR
deletion_protection

Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.

BOOLEAN
earliest_restorable_time

The earliest time to which a database can be restored with point-in-time restore.

TIMESTAMP_S
enabled_cloudwatch_logs_exports

A list of log types that this cluster is configured to export to Amazon CloudWatch Logs.

VARCHAR[]
Show child fields
enabled_cloudwatch_logs_exports[]
endpoint

Specifies the connection endpoint for the primary instance of the cluster.

VARCHAR
engine

Provides the name of the database engine to be used for this cluster.

VARCHAR
engine_version

Indicates the database engine version.

VARCHAR
hosted_zone_id

Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

VARCHAR
kms_key_id

If StorageEncrypted is true, the KMS key identifier for the encrypted cluster.

VARCHAR
latest_restorable_time

Specifies the latest time to which a database can be restored with point-in-time restore.

TIMESTAMP_S
master_username

Contains the master user name for the cluster.

VARCHAR
multi_az

Specifies whether the cluster has instances in multiple Availability Zones.

BOOLEAN
percent_progress

Specifies the progress of the operation as a percentage.

VARCHAR
port

Specifies the port that the database engine is listening on.

BIGINT
preferred_backup_window

Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod. 

VARCHAR
preferred_maintenance_window

Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

VARCHAR
read_replica_identifiers

Contains one or more identifiers of the secondary clusters that are associated with this cluster.

VARCHAR[]
Show child fields
read_replica_identifiers[]
reader_endpoint

The reader endpoint for the cluster. The reader endpoint for a cluster load balances connections across the Amazon DocumentDB replicas that are available in a cluster. As clients request new connections to the reader endpoint, Amazon DocumentDB distributes the connection requests among the Amazon DocumentDB replicas in the cluster. This functionality can help balance your read workload across multiple Amazon DocumentDB replicas in your cluster.

If a failover occurs, and the Amazon DocumentDB replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Amazon DocumentDB replicas in the cluster, you can then reconnect to the reader endpoint.

VARCHAR
replication_source_identifier

Contains the identifier of the source cluster if this cluster is a secondary cluster.

VARCHAR
status

Specifies the current state of this cluster.

VARCHAR
storage_encrypted

Specifies whether the cluster is encrypted.

BOOLEAN
storage_type

Storage type associated with your cluster

Storage type associated with your cluster

For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the Amazon DocumentDB Developer Guide.

Valid values for storage type - standard | iopt1

Default value is standard 

VARCHAR
vpc_security_groups

Provides a list of virtual private cloud (VPC) security groups that the cluster belongs to.

STRUCT(
    "vpc_security_group_id" VARCHAR,
    "status" VARCHAR
)[]
Show child fields
vpc_security_groups[]
Show child fields
vpc_security_groups[].status

The status of the VPC security group.

vpc_security_groups[].vpc_security_group_id

The name of the VPC security group.