Skip to content
AWS for Query.Farm

aws.rds.describe_db_instance_automated_backups

Example SQL Queries

SELECT * FROM
aws.rds.describe_db_instance_automated_backups;

Description

Displays backups for both current and deleted instances. For example, use this operation to find details about automated backups for previously deleted instances. Current instances with retention periods greater than zero (0) are returned for both the DescribeDBInstanceAutomatedBackups and DescribeDBInstances operations.

All parameters are optional.

Table Definition

Column NameColumn Data Type
db_instance_automated_backups_arn Input Column

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

VARCHAR
db_instance_identifier Input Column

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

VARCHAR
dbi_resource_id Input Column

The resource ID for the source DB instance, 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

    • active - Automated backups for current instances.

    • creating - Automated backups that are waiting for the first automated snapshot to be available.

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

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

  • dbi-resource-id - Accepts DB resource identifiers and Amazon Resource Names (ARNs). The results list includes only information about the DB instance 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

The allocated storage size for the the automated backup in gibibytes (GiB).

BIGINT
availability_zone

The Availability Zone that the automated backup was created in. For information on Amazon Web Services Regions and Availability Zones, see Regions and Availability Zones.

VARCHAR
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
backup_target

The location where automated backups are stored: Amazon Web Services Outposts or the Amazon Web Services Region.

VARCHAR
db_instance_arn

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

VARCHAR
db_instance_automated_backups_replications

The list of replications to different Amazon Web Services Regions associated with the automated backup.

STRUCT(
    "db_instance_automated_backups_arn" VARCHAR
)[]
Show child fields
db_instance_automated_backups_replications[]
Show child fields
db_instance_automated_backups_replications[].db_instance_automated_backups_arn

The Amazon Resource Name (ARN) of the replicated automated backups.

dedicated_log_volume

Indicates whether the DB instance has a dedicated log volume (DLV) enabled.

BOOLEAN
encrypted

Indicates whether the automated backup is encrypted.

BOOLEAN
engine

The name of the database engine for this automated backup.

VARCHAR
engine_version

The version of the database engine for the automated backup.

VARCHAR
iam_database_authentication_enabled

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

BOOLEAN
instance_create_time

The date and time when the DB instance was created.

TIMESTAMP_S
iops

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

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

VARCHAR
master_username

The master user name of an automated backup.

VARCHAR
multi_tenant

Specifies whether the automatic backup is for a DB instance in the multi-tenant configuration (TRUE) or the single-tenant configuration (FALSE). 

BOOLEAN
option_group_name

The option group the automated backup is associated with. If omitted, the default option group for the engine specified is used.

VARCHAR
port

The port number that the automated backup used for connections.

Default: Inherits from the source DB instance

Valid Values: 1150-65535 

BIGINT
region

The Amazon Web Services Region associated with the automated backup.

VARCHAR
restore_window

The earliest and latest time a DB 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:

  • active - Automated backups for current instances.

  • retained - Automated backups for deleted instances.

  • creating - Automated backups that are waiting for the first automated snapshot to be available.

VARCHAR
storage_throughput

The storage throughput for the automated backup.

BIGINT
storage_type

The storage type associated with the automated backup.

VARCHAR
tde_credential_arn

The ARN from the key store with which the automated backup is associated for TDE encryption.

VARCHAR
timezone

The time zone of the automated backup. In most cases, the Timezone element is empty. Timezone content appears only for Microsoft SQL Server DB instances that were created with a time zone specified.

VARCHAR
vpc_id

The VPC ID associated with the DB instance.

VARCHAR