Skip to content

RDS  >  Structures  >  DBInstanceAutomatedBackup

DBInstanceAutomatedBackup

Structure Class

DBInstanceAutomatedBackup dataclass

Bases: _SerdeShape

An automated backup of a DB instance. It consists of system backups, transaction logs, and the database instance properties that existed at the time you deleted the source instance.

Attributes

additional_storage_volumes class-attribute instance-attribute 
additional_storage_volumes: list[AdditionalStorageVolume] | None = ...

The additional storage volumes associated with the automated backup.

Valid Values: GP3 | IO2

allocated_storage class-attribute instance-attribute 
allocated_storage: int | None = ...

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

availability_zone class-attribute instance-attribute 
availability_zone: str | None = ...

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.

aws_backup_recovery_point_arn class-attribute instance-attribute 
aws_backup_recovery_point_arn: str | None = ...

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

backup_retention_period class-attribute instance-attribute 
backup_retention_period: int | None = ...

The retention period for the automated backups.

backup_target class-attribute instance-attribute 
backup_target: str | None = ...

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

db_instance_arn class-attribute instance-attribute 
db_instance_arn: str | None = ...

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

db_instance_automated_backups_arn class-attribute instance-attribute 
db_instance_automated_backups_arn: str | None = ...

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

db_instance_automated_backups_replications class-attribute instance-attribute 
db_instance_automated_backups_replications: list[DBInstanceAutomatedBackupsReplication] | None = ...

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

db_instance_identifier class-attribute instance-attribute 
db_instance_identifier: str | None = ...

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

dbi_resource_id class-attribute instance-attribute 
dbi_resource_id: str | None = ...

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

dedicated_log_volume class-attribute instance-attribute 
dedicated_log_volume: bool | None = ...

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

encrypted class-attribute instance-attribute 
encrypted: bool | None = ...

Indicates whether the automated backup is encrypted.

engine class-attribute instance-attribute 
engine: str | None = ...

The name of the database engine for this automated backup.

engine_version class-attribute instance-attribute 
engine_version: str | None = ...

The version of the database engine for the automated backup.

iam_database_authentication_enabled class-attribute instance-attribute 
iam_database_authentication_enabled: bool | None = ...

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

instance_create_time class-attribute instance-attribute 
instance_create_time: datetime | None = ...

The date and time when the DB instance was created.

iops class-attribute instance-attribute 
iops: int | None = ...

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

kms_key_id class-attribute instance-attribute 
kms_key_id: str | None = ...

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.

license_model class-attribute instance-attribute 
license_model: str | None = ...

The license model information for the automated backup.

master_username class-attribute instance-attribute 
master_username: str | None = ...

The master user name of an automated backup.

multi_tenant class-attribute instance-attribute 
multi_tenant: bool | None = ...

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

option_group_name class-attribute instance-attribute 
option_group_name: str | None = ...

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

port class-attribute instance-attribute 
port: int | None = ...

The port number that the automated backup used for connections.

Default: Inherits from the source DB instance

Valid Values: 1150-65535

preferred_backup_window class-attribute instance-attribute 
preferred_backup_window: str | None = ...

The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

region class-attribute instance-attribute 
region: str | None = ...

The Amazon Web Services Region associated with the automated backup.

restore_window class-attribute instance-attribute 
restore_window: RestoreWindow | None = ...

The earliest and latest time a DB instance can be restored to.

status class-attribute instance-attribute 
status: str | None = ...

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.

storage_encryption_type class-attribute instance-attribute 
storage_encryption_type: str | None = ...

The type of encryption used to protect data at rest in the automated backup. Possible values:

  • none - The automated backup is not encrypted.

  • sse-rds - The automated backup is encrypted using an Amazon Web Services owned KMS key.

  • sse-kms - The automated backup is encrypted using a customer managed KMS key or Amazon Web Services managed KMS key.

storage_throughput class-attribute instance-attribute 
storage_throughput: int | None = ...

The storage throughput for the automated backup.

storage_type class-attribute instance-attribute 
storage_type: str | None = ...

The storage type associated with the automated backup.

tag_list class-attribute instance-attribute 
tag_list: list[Tag] | None = ...

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.

tde_credential_arn class-attribute instance-attribute 
tde_credential_arn: str | None = ...

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

timezone class-attribute instance-attribute 
timezone: str | None = ...

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.

vpc_id class-attribute instance-attribute 
vpc_id: str | None = ...

The VPC ID associated with the DB instance.