Skip to content
AWS for Query.Farm

aws.docdb_elastic.get_cluster_snapshot

Example SQL Queries

SELECT * FROM
aws.docdb_elastic.get_cluster_snapshot
WHERE
"snapshot_arn" = 'VALUE';

Description

Returns information about a specific elastic cluster snapshot

Table Definition

Column NameColumn Data Type
snapshot_arn Required Input Column

The ARN identifier of the elastic cluster snapshot.

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.

snapshot

Returns information about a specific elastic cluster snapshot.

STRUCT(
    "admin_user_name" VARCHAR,
    "cluster_arn" VARCHAR,
    "cluster_creation_time" VARCHAR,
    "kms_key_id" VARCHAR,
    "snapshot_arn" VARCHAR,
    "snapshot_creation_time" VARCHAR,
    "snapshot_name" VARCHAR,
    "snapshot_type" VARCHAR,
    "status" VARCHAR,
    "subnet_ids" VARCHAR[],
    "vpc_security_group_ids" VARCHAR[]
)
Show child fields
snapshot.admin_user_name

The name of the elastic cluster administrator.

snapshot.cluster_arn

The ARN identifier of the elastic cluster.

snapshot.cluster_creation_time

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

snapshot.kms_key_id

The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a cluster using the same Amazon account that owns this KMS encryption key, you can use the KMS key alias instead of the ARN as the KMS encryption key. If an encryption key is not specified here, Amazon DocumentDB uses the default encryption key that KMS creates for your account. Your account has a different default encryption key for each Amazon Region.

snapshot.snapshot_arn

The ARN identifier of the elastic cluster snapshot.

snapshot.snapshot_creation_time

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

snapshot.snapshot_name

The name of the elastic cluster snapshot.

snapshot.snapshot_type

The type of cluster snapshots to be returned. You can specify one of the following values:

  • automated - Return all cluster snapshots that Amazon DocumentDB has automatically created for your Amazon Web Services account.

  • manual - Return all cluster snapshots that you have manually created for your Amazon Web Services account.

snapshot.status

The status of the elastic cluster snapshot.

snapshot.subnet_ids[]
snapshot.vpc_security_group_ids[]