Skip to content
AWS for Query.Farm

aws.rds.describe_db_cluster_automated_backups

Example SQL Queries

SELECT * FROM
aws.rds.describe_db_cluster_automated_backups;

Description

Displays backups for both current and deleted DB clusters. For example, use this operation to find details about automated backups for previously deleted clusters. Current clusters are returned for both the DescribeDBClusterAutomatedBackups and DescribeDBClusters operations.

All parameters are optional.

Table Definition

Column NameColumn Data Type
db_cluster_identifier Input Column

The identifier for the source DB cluster, which can't be changed and which is unique to an Amazon Web Services Region.

VARCHAR
db_cluster_resource_id Input Column

The resource ID for the source DB cluster, which can't be changed and which is unique to an Amazon Web Services Region.

VARCHAR
filters Input Column

A filter that specifies which resources to return based on status.

Supported filters are the following:

  • status

    • retained - Automated backups for deleted clusters and after backup replication is stopped.

  • db-cluster-id - Accepts DB cluster identifiers and Amazon Resource Names (ARNs). The results list includes only information about the DB cluster automated backups identified by these ARNs.

  • db-cluster-resource-id - Accepts DB resource identifiers and Amazon Resource Names (ARNs). The results list includes only information about the DB cluster resources identified by these ARNs.

Returns all resources by default. The status for each resource is specified in the response.

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[]
_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

For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gibibytes (GiB). For Aurora, AllocatedStorage always returns 1, because Aurora DB cluster storage size isn't fixed, but instead automatically adjusts as needed.

BIGINT
availability_zones

The Availability Zones where instances in the DB cluster can be created. For information on Amazon Web Services Regions and Availability Zones, see Regions and Availability Zones.

VARCHAR[]
Show child fields
availability_zones[]
aws_backup_recovery_point_arn

The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.

VARCHAR
backup_retention_period

The retention period for the automated backups.

BIGINT
cluster_create_time

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

TIMESTAMP_S
db_cluster_arn

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

VARCHAR
db_cluster_automated_backups_arn

The Amazon Resource Name (ARN) for the automated backups.

VARCHAR
engine

The name of the database engine for this automated backup.

VARCHAR
engine_mode

The engine mode of the database engine for the automated backup.

VARCHAR
engine_version

The version of the database engine for the automated backup.

VARCHAR
iam_database_authentication_enabled

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

BOOLEAN
iops

The IOPS (I/O operations per second) value for the automated backup.

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

BIGINT
kms_key_id

The Amazon Web Services KMS key ID for an automated backup.

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 automated backup.

VARCHAR
master_username

The master user name of the automated backup.

VARCHAR
port

The port number that the automated backup used for connections.

Default: Inherits from the source DB cluster

Valid Values: 1150-65535 

BIGINT
region

The Amazon Web Services Region associated with the automated backup.

VARCHAR
restore_window

Earliest and latest time an instance can be restored to:

STRUCT(
    "earliest_time" TIMESTAMP_S,
    "latest_time" TIMESTAMP_S
)
Show child fields
restore_window.earliest_time

The earliest time you can restore an instance to.

restore_window.latest_time

The latest time you can restore an instance to.

status

A list of status information for an automated backup:

  • retained - Automated backups for deleted clusters.

VARCHAR
storage_encrypted

Indicates whether the source DB cluster is encrypted.

BOOLEAN
storage_throughput

The storage throughput for the automated backup. 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.

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

VARCHAR
vpc_id

The VPC ID associated with the DB cluster.

VARCHAR