Skip to content
AWS for Query.Farm

aws.docdb.describe_db_cluster_snapshot_attributes

Example SQL Queries

SELECT * FROM
aws.docdb.describe_db_cluster_snapshot_attributes
WHERE
"db_cluster_snapshot_identifier" = 'VALUE';

Description

Returns a list of cluster snapshot attribute names and values for a manual DB cluster snapshot.

When you share snapshots with other Amazon Web Services accounts, DescribeDBClusterSnapshotAttributes returns the restore attribute and a list of IDs for the Amazon Web Services accounts that are authorized to copy or restore the manual cluster snapshot. If all is included in the list of values for the restore attribute, then the manual cluster snapshot is public and can be copied or restored by all Amazon Web Services accounts.

Table Definition

Column NameColumn Data Type
db_cluster_snapshot_identifier Required Input Column

The identifier for the cluster snapshot to describe the attributes for.

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
db_cluster_snapshot_attributes_result

Detailed information about the attributes that are associated with a cluster snapshot.

STRUCT(
    "db_cluster_snapshot_identifier" VARCHAR,
    "db_cluster_snapshot_attributes" STRUCT(
        "attribute_name" VARCHAR,
        "attribute_values" VARCHAR[]
    )[]
)
Show child fields
db_cluster_snapshot_attributes_result.db_cluster_snapshot_attributes[]
Show child fields
db_cluster_snapshot_attributes_result.db_cluster_snapshot_attributes[].attribute_name

The name of the manual cluster snapshot attribute.

The attribute named restore refers to the list of Amazon Web Services accounts that have permission to copy or restore the manual cluster snapshot.

db_cluster_snapshot_attributes_result.db_cluster_snapshot_attributes[].attribute_values[]
db_cluster_snapshot_attributes_result.db_cluster_snapshot_identifier

The identifier of the cluster snapshot that the attributes apply to.