Skip to content
AWS for Query.Farm

aws.neptune.describe_db_cluster_snapshots

Example SQL Queries

SELECT * FROM
aws.neptune.describe_db_cluster_snapshots;

Description

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

Table Definition

Column NameColumn Data Type
db_cluster_identifier Input Column

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

VARCHAR
db_cluster_snapshot_identifier Input Column

Specifies the identifier for a DB cluster snapshot. Must match the identifier of an existing snapshot.

After you restore a DB cluster using a DBClusterSnapshotIdentifier, you must specify the same DBClusterSnapshotIdentifier for any future updates to the DB cluster. When you specify this property for an update, the DB cluster is not restored from the snapshot again, and the data in the database is not changed.

However, if you don't specify the DBClusterSnapshotIdentifier, an empty DB cluster is created, and the original DB cluster is deleted. If you specify a property that is different from the previous snapshot restore property, the DB cluster is restored from the snapshot specified by the DBClusterSnapshotIdentifier, and the original DB cluster is deleted.

VARCHAR
filters Input Column

This parameter is not currently supported.

STRUCT(
    "name" VARCHAR,
    "values" VARCHAR[]
)[]
Show child fields
filters[]
Show child fields
filters[].name

This parameter is not currently supported.

filters[].values[]
include_public Input Column

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

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

BOOLEAN
include_shared Input Column

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

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

BOOLEAN
snapshot_type Input Column

Provides 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

Specifies the allocated storage size in gibibytes (GiB).

BIGINT
availability_zones

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

VARCHAR[]
Show child fields
availability_zones[]
cluster_create_time

Specifies 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
engine

Specifies the name of the database engine.

VARCHAR
engine_version

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

VARCHAR
iam_database_authentication_enabled

True if mapping of Amazon Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

BOOLEAN
kms_key_id

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

VARCHAR
license_model

Provides the license model information for this DB cluster snapshot.

VARCHAR
master_username

Not supported by Neptune.

VARCHAR
percent_progress

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

BIGINT
port

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

BIGINT
snapshot_create_time

Provides 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

Specifies the status of this DB cluster snapshot.

VARCHAR
storage_encrypted

Specifies whether the DB cluster snapshot is encrypted.

BOOLEAN
storage_type

The storage type associated with the DB cluster snapshot.

VARCHAR
vpc_id

Provides the VPC ID associated with the DB cluster snapshot.

VARCHAR