Documentation

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.

See: newDBInstanceAutomatedBackup smart constructor.

Create a value of DBInstanceAutomatedBackup with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:allocatedStorage:DBInstanceAutomatedBackup', dbInstanceAutomatedBackup_allocatedStorage - Specifies the allocated storage size in gibibytes (GiB).

$sel:availabilityZone:DBInstanceAutomatedBackup', dbInstanceAutomatedBackup_availabilityZone - 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.

$sel:backupRetentionPeriod:DBInstanceAutomatedBackup', dbInstanceAutomatedBackup_backupRetentionPeriod - The retention period for the automated backups.

$sel:backupTarget:DBInstanceAutomatedBackup', dbInstanceAutomatedBackup_backupTarget - Specifies where automated backups are stored: Amazon Web Services Outposts or the Amazon Web Services Region.

$sel:dbInstanceArn:DBInstanceAutomatedBackup', dbInstanceAutomatedBackup_dbInstanceArn - The Amazon Resource Name (ARN) for the automated backups.

DBInstanceAutomatedBackup, dbInstanceAutomatedBackup_dbInstanceAutomatedBackupsArn - The Amazon Resource Name (ARN) for the replicated automated backups.

$sel:dbInstanceAutomatedBackupsReplications:DBInstanceAutomatedBackup', dbInstanceAutomatedBackup_dbInstanceAutomatedBackupsReplications - The list of replications to different Amazon Web Services Regions associated with the automated backup.

$sel:dbInstanceIdentifier:DBInstanceAutomatedBackup', dbInstanceAutomatedBackup_dbInstanceIdentifier - The customer id of the instance that is/was associated with the automated backup.

$sel:dbiResourceId:DBInstanceAutomatedBackup', dbInstanceAutomatedBackup_dbiResourceId - The identifier for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region.

$sel:encrypted:DBInstanceAutomatedBackup', dbInstanceAutomatedBackup_encrypted - Specifies whether the automated backup is encrypted.

$sel:engine:DBInstanceAutomatedBackup', dbInstanceAutomatedBackup_engine - The name of the database engine for this automated backup.

$sel:engineVersion:DBInstanceAutomatedBackup', dbInstanceAutomatedBackup_engineVersion - The version of the database engine for the automated backup.

$sel:iAMDatabaseAuthenticationEnabled:DBInstanceAutomatedBackup', dbInstanceAutomatedBackup_iAMDatabaseAuthenticationEnabled - True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

$sel:instanceCreateTime:DBInstanceAutomatedBackup', dbInstanceAutomatedBackup_instanceCreateTime - Provides the date and time that the DB instance was created.

$sel:iops:DBInstanceAutomatedBackup', dbInstanceAutomatedBackup_iops - The IOPS (I/O operations per second) value for the automated backup.

$sel:kmsKeyId:DBInstanceAutomatedBackup', dbInstanceAutomatedBackup_kmsKeyId - 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.

$sel:licenseModel:DBInstanceAutomatedBackup', dbInstanceAutomatedBackup_licenseModel - License model information for the automated backup.

$sel:masterUsername:DBInstanceAutomatedBackup', dbInstanceAutomatedBackup_masterUsername - The license model of an automated backup.

$sel:optionGroupName:DBInstanceAutomatedBackup', dbInstanceAutomatedBackup_optionGroupName - The option group the automated backup is associated with. If omitted, the default option group for the engine specified is used.

$sel:port:DBInstanceAutomatedBackup', dbInstanceAutomatedBackup_port - The port number that the automated backup used for connections.

Default: Inherits from the source DB instance

Valid Values: 1150-65535

$sel:region:DBInstanceAutomatedBackup', dbInstanceAutomatedBackup_region - The Amazon Web Services Region associated with the automated backup.

$sel:restoreWindow:DBInstanceAutomatedBackup', dbInstanceAutomatedBackup_restoreWindow - Earliest and latest time an instance can be restored to.

$sel:status:DBInstanceAutomatedBackup', dbInstanceAutomatedBackup_status - Provides 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.

$sel:storageThroughput:DBInstanceAutomatedBackup', dbInstanceAutomatedBackup_storageThroughput - Specifies the storage throughput for the automated backup.

$sel:storageType:DBInstanceAutomatedBackup', dbInstanceAutomatedBackup_storageType - Specifies the storage type associated with the automated backup.

$sel:tdeCredentialArn:DBInstanceAutomatedBackup', dbInstanceAutomatedBackup_tdeCredentialArn - The ARN from the key store with which the automated backup is associated for TDE encryption.

$sel:timezone:DBInstanceAutomatedBackup', dbInstanceAutomatedBackup_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.

$sel:vpcId:DBInstanceAutomatedBackup', dbInstanceAutomatedBackup_vpcId - Provides the VPC ID associated with the DB instance.

Specifies the allocated storage size in gibibytes (GiB).

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.

The retention period for the automated backups.

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

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

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

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

The customer id of the instance that is/was associated with the automated backup.

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

Specifies whether the automated backup is encrypted.

The name of the database engine for this automated backup.

The version of the database engine for the automated backup.

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

Provides the date and time that the DB instance was created.

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

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

The license model of an automated backup.

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

The port number that the automated backup used for connections.

Default: Inherits from the source DB instance

Valid Values: 1150-65535

The Amazon Web Services Region associated with the automated backup.

Earliest and latest time an instance can be restored to.

Provides 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.

Specifies the storage throughput for the automated backup.

Specifies the storage type associated with the automated backup.

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

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.

Provides the VPC ID associated with the DB instance.