Skip to content
AWS for Query.Farm

aws.rds.describe_db_cluster_snapshots

Example SQL Queries

SELECT * FROM
aws.rds.describe_db_cluster_snapshots;

Description

Returns information about DB cluster snapshots. This API action supports pagination.

For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.

For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.

Table Definition

Column NameColumn Data Type
db_cluster_identifier Input Column

The DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.

VARCHAR
db_cluster_resource_id Input Column

The resource ID of the DB cluster that this DB cluster snapshot was created from.

VARCHAR
db_cluster_snapshot_identifier Input Column

The identifier for the DB cluster snapshot.

VARCHAR
filters Input Column

A filter that specifies one or more DB cluster snapshots to describe.

Supported filters:

  • db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs).

  • db-cluster-snapshot-id - Accepts DB cluster snapshot identifiers.

  • snapshot-type - Accepts types of DB cluster snapshots.

  • engine - Accepts names of database engines.

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

Specifies whether to include manual DB cluster snapshots that are public and can be copied or restored by any Amazon Web Services account. By default, the public snapshots are not included.

You can share a manual DB cluster snapshot as public by using the ModifyDBClusterSnapshotAttribute API action.

BOOLEAN
include_shared Input Column

Specifies whether to include shared manual DB cluster snapshots from other Amazon Web Services accounts that this Amazon Web Services account has been given permission to copy or restore. By default, these snapshots are not included.

You can give an Amazon Web Services account permission to restore a manual DB cluster snapshot from another Amazon Web Services account by the ModifyDBClusterSnapshotAttribute API action.

BOOLEAN
snapshot_type Input Column

The type of the DB 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
allocated_storage

The allocated storage size of the DB cluster snapshot in gibibytes (GiB).

BIGINT
availability_zones

The list of Availability Zones (AZs) where instances in the DB cluster snapshot can be restored.

VARCHAR[]
Show child fields
availability_zones[]
cluster_create_time

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

TIMESTAMP_S
db_cluster_snapshot_arn

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

VARCHAR
db_system_id

Reserved for future use.

VARCHAR
engine

The name of the database engine for this DB cluster snapshot.

VARCHAR
engine_mode

The engine mode of the database engine for this DB cluster snapshot.

VARCHAR
engine_version

The version of the database engine for this DB cluster snapshot.

VARCHAR
iam_database_authentication_enabled

Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.

BOOLEAN
kms_key_id

If StorageEncrypted is true, the Amazon Web Services KMS key identifier for the encrypted DB cluster snapshot.

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

VARCHAR
license_model

The license model information for this DB cluster snapshot.

VARCHAR
master_username

The master username for this DB cluster snapshot.

VARCHAR
percent_progress

The percentage of the estimated data that has been transferred.

BIGINT
port

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

BIGINT
snapshot_create_time

The time when the snapshot was taken, in Universal Coordinated Time (UTC).

TIMESTAMP_S
source_db_cluster_snapshot_arn

If the DB cluster snapshot was copied from a source DB cluster snapshot, the Amazon Resource Name (ARN) for the source DB cluster snapshot, otherwise, a null value.

VARCHAR
status

The status of this DB cluster snapshot. Valid statuses are the following:

  • available

  • copying

  • creating 

VARCHAR
storage_encrypted

Indicates whether the DB cluster snapshot is encrypted.

BOOLEAN
storage_throughput

The storage throughput for the DB cluster snapshot. The throughput is automatically set based on the IOPS that you provision, and is not configurable.

This setting is only for non-Aurora Multi-AZ DB clusters.

BIGINT
storage_type

The storage type associated with the DB cluster snapshot.

This setting is only for Aurora DB clusters.

VARCHAR
tag_list

A list of tags.

For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide. 

STRUCT(
    "key" VARCHAR,
    "value" VARCHAR
)[]
Show child fields
tag_list[]
Show child fields
tag_list[].key

A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$").

tag_list[].value

A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$").

vpc_id

The VPC ID associated with the DB cluster snapshot.

VARCHAR