DBInstanceAutomatedBackup - Amazon Relational Database Service
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.

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.

Contents

AllocatedStorage

Specifies the allocated storage size in gibibytes (GiB).

Type: Integer

Required: No

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.

Type: String

Required: No

BackupRetentionPeriod

The retention period for the automated backups.

Type: Integer

Required: No

BackupTarget

Specifies where automated backups are stored: Amazon Outposts or the Amazon Web Services 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 Amazon Web Services Regions associated with the automated backup.

Type: Array of DBInstanceAutomatedBackupsReplication objects

Required: No

DBInstanceIdentifier

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

Type: String

Required: No

DbiResourceId

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

Type: String

Required: No

Encrypted

Specifies 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 Amazon Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

Type: Boolean

Required: No

InstanceCreateTime

Provides the date and time that 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 Amazon KMS key ID for an automated backup.

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

Type: String

Required: No

LicenseModel

License model information for the automated backup.

Type: String

Required: No

MasterUsername

The license model of an automated backup.

Type: String

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 Amazon Web Services Region associated with the automated backup.

Type: String

Required: No

RestoreWindow

Earliest and latest time an instance can be restored to.

Type: RestoreWindow object

Required: No

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.

Type: String

Required: No

StorageThroughput

Specifies the storage throughput for the automated backup.

Type: Integer

Required: No

StorageType

Specifies 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

Provides the VPC ID associated with the DB instance.

Type: String

Required: No

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: