DBInstanceAutomatedBackup

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.

Note

In the following list, the required parameters are described first.

AllocatedStorage

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

Type: Integer

Required: No

AvailabilityZone

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

Type: String

Required: No

AwsBackupRecoveryPointArn

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

Type: String

Required: No

BackupRetentionPeriod

The retention period for the automated backups.

Type: Integer

Required: No

BackupTarget

The location where automated backups are stored: AWS Outposts or the AWS Region.

Type: String

Required: No

DBInstanceArn

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

Type: String

Required: No

DBInstanceAutomatedBackupsArn

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

Type: String

Required: No

DBInstanceAutomatedBackupsReplications.DBInstanceAutomatedBackupsReplication.N

The list of replications to different AWS Regions associated with the automated backup.

Type: Array of DBInstanceAutomatedBackupsReplication objects

Required: No

DBInstanceIdentifier

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

Type: String

Required: No

DbiResourceId

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

Type: String

Required: No

DedicatedLogVolume

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

Type: Boolean

Required: No

Encrypted

Indicates whether the automated backup is encrypted.

Type: Boolean

Required: No

Engine

The name of the database engine for this automated backup.

Type: String

Required: No

EngineVersion

The version of the database engine for the automated backup.

Type: String

Required: No

IAMDatabaseAuthenticationEnabled

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

Type: Boolean

Required: No

InstanceCreateTime

The date and time when the DB instance was created.

Type: Timestamp

Required: No

Iops

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

Type: Integer

Required: No

KmsKeyId

The AWS KMS key ID for an automated backup.

The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

Type: String

Required: No

LicenseModel

The license model information for the automated backup.

Type: String

Required: No

MasterUsername

The master user name of an automated backup.

Type: String

Required: No

MultiTenant

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

Type: Boolean

Required: No

OptionGroupName

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

Type: String

Required: No

Port

The port number that the automated backup used for connections.

Default: Inherits from the source DB instance

Valid Values: 1150-65535

Type: Integer

Required: No

Region

The AWS Region associated with the automated backup.

Type: String

Required: No

RestoreWindow

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

Type: RestoreWindow object

Required: No

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.

Type: String

Required: No

StorageThroughput

The storage throughput for the automated backup.

Type: Integer

Required: No

StorageType

The storage type associated with the automated backup.

Type: String

Required: No

TdeCredentialArn

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

Type: String

Required: No

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.

Type: String

Required: No

VpcId

The VPC ID associated with the DB instance.

Type: String

Required: No

DBInstanceAutomatedBackup

Contents

Note

See Also