Skip to content

DBInstanceAutomatedBackup

Source code in docs_src/capo_rds/types/db_instance_automated_backup.py
class DBInstanceAutomatedBackup(TypedDict, closed=True):
    db_instance_arn: NotRequired["capo_rds.types.string.String"]
    """<p>The Amazon Resource Name (ARN) for the automated backups.</p>"""
    dbi_resource_id: NotRequired["capo_rds.types.string.String"]
    """<p>The resource ID for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region.</p>"""
    region: NotRequired["capo_rds.types.string.String"]
    """<p>The Amazon Web Services Region associated with the automated backup.</p>"""
    db_instance_identifier: NotRequired["capo_rds.types.string.String"]
    """<p>The identifier for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region.</p>"""
    restore_window: NotRequired["capo_rds.types.restore_window.RestoreWindow"]
    """<p>The earliest and latest time a DB instance can be restored to.</p>"""
    allocated_storage: NotRequired["capo_rds.types.integer.Integer"]
    """<p>The allocated storage size for the automated backup in gibibytes (GiB).</p>"""
    status: NotRequired["capo_rds.types.string.String"]
    """<p>A list of status information for an automated backup:</p> <ul> <li> <p> <code>active</code> - Automated backups for current instances.</p> </li> <li> <p> <code>retained</code> - Automated backups for deleted instances.</p> </li> <li> <p> <code>creating</code> - Automated backups that are waiting for the first automated snapshot to be available.</p> </li> </ul>"""
    port: NotRequired["capo_rds.types.integer.Integer"]
    """<p>The port number that the automated backup used for connections.</p> <p>Default: Inherits from the source DB instance</p> <p>Valid Values: <code>1150-65535</code> </p>"""
    availability_zone: NotRequired["capo_rds.types.string.String"]
    """<p>The Availability Zone that the automated backup was created in. For information on Amazon Web Services Regions and Availability Zones, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html">Regions and Availability Zones</a>.</p>"""
    vpc_id: NotRequired["capo_rds.types.string.String"]
    """<p>The VPC ID associated with the DB instance.</p>"""
    instance_create_time: NotRequired["capo_rds.types.t_stamp.TStamp"]
    """<p>The date and time when the DB instance was created.</p>"""
    master_username: NotRequired["capo_rds.types.string.String"]
    """<p>The master user name of an automated backup.</p>"""
    engine: NotRequired["capo_rds.types.string.String"]
    """<p>The name of the database engine for this automated backup.</p>"""
    engine_version: NotRequired["capo_rds.types.string.String"]
    """<p>The version of the database engine for the automated backup.</p>"""
    license_model: NotRequired["capo_rds.types.string.String"]
    """<p>The license model information for the automated backup.</p>"""
    iops: NotRequired["capo_rds.types.integer_optional.IntegerOptional"]
    """<p>The IOPS (I/O operations per second) value for the automated backup.</p>"""
    storage_throughput: NotRequired["capo_rds.types.integer_optional.IntegerOptional"]
    """<p>The storage throughput for the automated backup.</p>"""
    option_group_name: NotRequired["capo_rds.types.string.String"]
    """<p>The option group the automated backup is associated with. If omitted, the default option group for the engine specified is used.</p>"""
    tde_credential_arn: NotRequired["capo_rds.types.string.String"]
    """<p>The ARN from the key store with which the automated backup is associated for TDE encryption.</p>"""
    encrypted: NotRequired["capo_rds.types.boolean.Boolean"]
    """<p>Indicates whether the automated backup is encrypted.</p>"""
    storage_encryption_type: NotRequired[
        "capo_rds.types.storage_encryption_type.StorageEncryptionType"
    ]
    """<p>The type of encryption used to protect data at rest in the automated backup. Possible values:</p> <ul> <li> <p> <code>none</code> - The automated backup is not encrypted.</p> </li> <li> <p> <code>sse-rds</code> - The automated backup is encrypted using an Amazon Web Services owned KMS key.</p> </li> <li> <p> <code>sse-kms</code> - The automated backup is encrypted using a customer managed KMS key or Amazon Web Services managed KMS key.</p> </li> </ul>"""
    storage_type: NotRequired["capo_rds.types.string.String"]
    """<p>The storage type associated with the automated backup.</p>"""
    kms_key_id: NotRequired["capo_rds.types.string.String"]
    """<p>The Amazon Web Services KMS key ID for an automated backup.</p> <p>The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.</p>"""
    timezone: NotRequired["capo_rds.types.string.String"]
    """<p>The time zone of the automated backup. In most cases, the <code>Timezone</code> element is empty. <code>Timezone</code> content appears only for Microsoft SQL Server DB instances that were created with a time zone specified.</p>"""
    iam_database_authentication_enabled: NotRequired["capo_rds.types.boolean.Boolean"]
    """<p>True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.</p>"""
    backup_retention_period: NotRequired[
        "capo_rds.types.integer_optional.IntegerOptional"
    ]
    """<p>The retention period for the automated backups.</p>"""
    preferred_backup_window: NotRequired["capo_rds.types.string.String"]
    """<p>The daily time range during which automated backups are created if automated backups are enabled, as determined by the <code>BackupRetentionPeriod</code>.</p>"""
    db_instance_automated_backups_arn: NotRequired["capo_rds.types.string.String"]
    """<p>The Amazon Resource Name (ARN) for the replicated automated backups.</p>"""
    db_instance_automated_backups_replications: NotRequired[
        "capo_rds.types.db_instance_automated_backups_replication_list.DBInstanceAutomatedBackupsReplicationList"
    ]
    """<p>The list of replications to different Amazon Web Services Regions associated with the automated backup.</p>"""
    backup_target: NotRequired["capo_rds.types.string.String"]
    """<p>The location where automated backups are stored: Dedicated Local Zones, Amazon Web Services Outposts or the Amazon Web Services Region.</p>"""
    multi_tenant: NotRequired["capo_rds.types.boolean_optional.BooleanOptional"]
    """<p>Specifies whether the automatic backup is for a DB instance in the multi-tenant configuration (TRUE) or the single-tenant configuration (FALSE). </p>"""
    aws_backup_recovery_point_arn: NotRequired["capo_rds.types.string.String"]
    """<p>The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.</p>"""
    tag_list: NotRequired["capo_rds.types.tag_list.TagList"]
    dedicated_log_volume: NotRequired["capo_rds.types.boolean_optional.BooleanOptional"]
    """<p>Indicates whether the DB instance has a dedicated log volume (DLV) enabled.</p>"""
    additional_storage_volumes: NotRequired[
        "capo_rds.types.additional_storage_volumes_list.AdditionalStorageVolumesList"
    ]
    """<p>The additional storage volumes associated with the automated backup.</p> <p>Valid Values: <code>GP3 | IO2</code> </p>"""

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.

tag_list instance-attribute

tag_list: NotRequired[TagList]

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.

timezone instance-attribute

timezone: NotRequired[String]

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 instance-attribute

vpc_id: NotRequired[String]

The VPC ID associated with the DB instance.