DBInstanceAutomatedBackup
¶
Source code in docs_src/capo_rds/types/db_instance_automated_backup.py
additional_storage_volumes
instance-attribute
¶
additional_storage_volumes: NotRequired[AdditionalStorageVolumesList]
The additional storage volumes associated with the automated backup.
Valid Values: GP3 | IO2
allocated_storage
instance-attribute
¶
allocated_storage: NotRequired[Integer]
The allocated storage size for the automated backup in gibibytes (GiB).
availability_zone
instance-attribute
¶
availability_zone: NotRequired[String]
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
instance-attribute
¶
aws_backup_recovery_point_arn: NotRequired[String]
The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
backup_retention_period
instance-attribute
¶
backup_retention_period: NotRequired[IntegerOptional]
The retention period for the automated backups.
backup_target
instance-attribute
¶
backup_target: NotRequired[String]
The location where automated backups are stored: Dedicated Local Zones, Amazon Web Services Outposts or the Amazon Web Services Region.
db_instance_arn
instance-attribute
¶
db_instance_arn: NotRequired[String]
The Amazon Resource Name (ARN) for the automated backups.
db_instance_automated_backups_arn
instance-attribute
¶
db_instance_automated_backups_arn: NotRequired[String]
The Amazon Resource Name (ARN) for the replicated automated backups.
db_instance_automated_backups_replications
instance-attribute
¶
db_instance_automated_backups_replications: NotRequired[
DBInstanceAutomatedBackupsReplicationList
]
The list of replications to different Amazon Web Services Regions associated with the automated backup.
db_instance_identifier
instance-attribute
¶
db_instance_identifier: NotRequired[String]
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
instance-attribute
¶
dbi_resource_id: NotRequired[String]
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
instance-attribute
¶
dedicated_log_volume: NotRequired[BooleanOptional]
Indicates whether the DB instance has a dedicated log volume (DLV) enabled.
encrypted
instance-attribute
¶
encrypted: NotRequired[Boolean]
Indicates whether the automated backup is encrypted.
engine
instance-attribute
¶
engine: NotRequired[String]
The name of the database engine for this automated backup.
engine_version
instance-attribute
¶
engine_version: NotRequired[String]
The version of the database engine for the automated backup.
iam_database_authentication_enabled
instance-attribute
¶
iam_database_authentication_enabled: NotRequired[Boolean]
True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
instance_create_time
instance-attribute
¶
instance_create_time: NotRequired[TStamp]
The date and time when the DB instance was created.
iops
instance-attribute
¶
iops: NotRequired[IntegerOptional]
The IOPS (I/O operations per second) value for the automated backup.
kms_key_id
instance-attribute
¶
kms_key_id: NotRequired[String]
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
instance-attribute
¶
license_model: NotRequired[String]
The license model information for the automated backup.
master_username
instance-attribute
¶
master_username: NotRequired[String]
The master user name of an automated backup.
multi_tenant
instance-attribute
¶
multi_tenant: NotRequired[BooleanOptional]
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
instance-attribute
¶
option_group_name: NotRequired[String]
The option group the automated backup is associated with. If omitted, the default option group for the engine specified is used.
port
instance-attribute
¶
port: NotRequired[Integer]
The port number that the automated backup used for connections.
Default: Inherits from the source DB instance
Valid Values: 1150-65535
preferred_backup_window
instance-attribute
¶
preferred_backup_window: NotRequired[String]
The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
region
instance-attribute
¶
region: NotRequired[String]
The Amazon Web Services Region associated with the automated backup.
restore_window
instance-attribute
¶
restore_window: NotRequired[RestoreWindow]
The earliest and latest time a DB instance can be restored to.
status
instance-attribute
¶
status: NotRequired[String]
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
instance-attribute
¶
storage_encryption_type: NotRequired[StorageEncryptionType]
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
instance-attribute
¶
storage_throughput: NotRequired[IntegerOptional]
The storage throughput for the automated backup.
storage_type
instance-attribute
¶
storage_type: NotRequired[String]
The storage type associated with the automated backup.
tde_credential_arn
instance-attribute
¶
tde_credential_arn: NotRequired[String]
The ARN from the key store with which the automated backup is associated for TDE encryption.