Skip to content
AWS for Query.Farm

aws.docdb_elastic.get_cluster

Example SQL Queries

SELECT * FROM
aws.docdb_elastic.get_cluster
WHERE
"cluster_arn" = 'VALUE';

Description

Returns information about a specific elastic cluster.

Table Definition

Column NameColumn Data Type
cluster_arn Required Input Column

The ARN identifier of the elastic 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.

cluster

Returns information about a specific elastic cluster.

STRUCT(
    "admin_user_name" VARCHAR,
    "auth_type" VARCHAR,
    "backup_retention_period" BIGINT,
    "cluster_arn" VARCHAR,
    "cluster_endpoint" VARCHAR,
    "cluster_name" VARCHAR,
    "create_time" VARCHAR,
    "kms_key_id" VARCHAR,
    "preferred_backup_window" VARCHAR,
    "preferred_maintenance_window" VARCHAR,
    "shard_capacity" BIGINT,
    "shard_count" BIGINT,
    "shard_instance_count" BIGINT,
    "shards" STRUCT(
        "create_time" VARCHAR,
        "shard_id" VARCHAR,
        "status" VARCHAR
    )[],
    "status" VARCHAR,
    "subnet_ids" VARCHAR[],
    "vpc_security_group_ids" VARCHAR[]
)
Show child fields
cluster.admin_user_name

The name of the elastic cluster administrator.

cluster.auth_type

The authentication type for the elastic cluster.

cluster.backup_retention_period

The number of days for which automatic snapshots are retained.

cluster.cluster_arn

The ARN identifier of the elastic cluster.

cluster.cluster_endpoint

The URL used to connect to the elastic cluster.

cluster.cluster_name

The name of the elastic cluster.

cluster.create_time

The time when the elastic cluster was created in Universal Coordinated Time (UTC).

cluster.kms_key_id

The KMS key identifier to use to encrypt the elastic cluster.

cluster.preferred_backup_window

The daily time range during which automated backups are created if automated backups are enabled, as determined by backupRetentionPeriod.

cluster.preferred_maintenance_window

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

Format: ddd:hh24:mi-ddd:hh24:mi

cluster.shard_capacity

The number of vCPUs assigned to each elastic cluster shard. Maximum is 64. Allowed values are 2, 4, 8, 16, 32, 64.

cluster.shard_count

The number of shards assigned to the elastic cluster. Maximum is 32.

cluster.shard_instance_count

The number of replica instances applying to all shards in the cluster. A shardInstanceCount value of 1 means there is one writer instance, and any additional instances are replicas that can be used for reads and to improve availability.

cluster.shards[]
Show child fields
cluster.shards[].create_time

The time when the shard was created in Universal Coordinated Time (UTC).

cluster.shards[].shard_id

The ID of the shard.

cluster.shards[].status

The current status of the shard.

cluster.status

The status of the elastic cluster.

cluster.subnet_ids[]
cluster.vpc_security_group_ids[]