Skip to content
AWS for Query.Farm

aws.docdb.describe_db_cluster_snapshots

Example SQL Queries

SELECT * FROM
aws.docdb.describe_db_cluster_snapshots;

Description

Returns information about cluster snapshots. This API operation supports pagination.

Table Definition

Column NameColumn Data Type
db_cluster_identifier Input Column

Specifies the cluster identifier of the cluster that this cluster snapshot was created from.

VARCHAR
db_cluster_snapshot_identifier Input Column

Specifies the identifier for the cluster snapshot.

VARCHAR
filters Input Column

This parameter is not currently supported.

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[]
include_public Input Column

Set to true to include manual cluster snapshots that are public and can be copied or restored by any Amazon Web Services account, and otherwise false. The default is false.

BOOLEAN
include_shared Input Column

Set to true to include shared manual cluster snapshots from other Amazon Web Services accounts that this Amazon Web Services account has been given permission to copy or restore, and otherwise false. The default is false.

BOOLEAN
snapshot_type Input Column

Provides the type of the 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.

_aws_region Input Column

The AWS region to use.

VARCHAR
availability_zones

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

VARCHAR[]
Show child fields
availability_zones[]
cluster_create_time

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

TIMESTAMP_S
db_cluster_snapshot_arn

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

VARCHAR
engine

Specifies the name of the database engine.

VARCHAR
engine_version

Provides the version of the database engine for this cluster snapshot.

VARCHAR
kms_key_id

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

VARCHAR
master_username

Provides the master user name for the cluster snapshot.

VARCHAR
percent_progress

Specifies the percentage of the estimated data that has been transferred.

BIGINT
port

Specifies the port that the cluster was listening on at the time of the snapshot.

BIGINT
snapshot_create_time

Provides the time when the snapshot was taken, in UTC.

TIMESTAMP_S
source_db_cluster_snapshot_arn

If the cluster snapshot was copied from a source cluster snapshot, the ARN for the source cluster snapshot; otherwise, a null value.

VARCHAR
status

Specifies the status of this cluster snapshot.

VARCHAR
storage_encrypted

Specifies whether the cluster snapshot is encrypted.

BOOLEAN
storage_type

Storage type associated with your cluster snapshot

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_id

Provides the virtual private cloud (VPC) ID that is associated with the cluster snapshot.

VARCHAR