Documentation

Contains the details of an Amazon RDS DB snapshot.

This data type is used as a response element in the DescribeDBSnapshots action.

See: newDBSnapshot smart constructor.

Create a value of DBSnapshot 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:DBSnapshot', dbSnapshot_allocatedStorage - Specifies the allocated storage size in gibibytes (GiB).

$sel:availabilityZone:DBSnapshot', dbSnapshot_availabilityZone - Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot.

$sel:dbInstanceIdentifier:DBSnapshot', dbSnapshot_dbInstanceIdentifier - Specifies the DB instance identifier of the DB instance this DB snapshot was created from.

$sel:dbSnapshotArn:DBSnapshot', dbSnapshot_dbSnapshotArn - The Amazon Resource Name (ARN) for the DB snapshot.

$sel:dbSnapshotIdentifier:DBSnapshot', dbSnapshot_dbSnapshotIdentifier - Specifies the identifier for the DB snapshot.

$sel:dbiResourceId:DBSnapshot', dbSnapshot_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:DBSnapshot', dbSnapshot_encrypted - Specifies whether the DB snapshot is encrypted.

$sel:engine:DBSnapshot', dbSnapshot_engine - Specifies the name of the database engine.

$sel:engineVersion:DBSnapshot', dbSnapshot_engineVersion - Specifies the version of the database engine.

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

$sel:instanceCreateTime:DBSnapshot', dbSnapshot_instanceCreateTime - Specifies the time in Coordinated Universal Time (UTC) when the DB instance, from which the snapshot was taken, was created.

$sel:iops:DBSnapshot', dbSnapshot_iops - Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.

$sel:kmsKeyId:DBSnapshot', dbSnapshot_kmsKeyId - If Encrypted is true, the Amazon Web Services KMS key identifier for the encrypted DB snapshot.

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

$sel:licenseModel:DBSnapshot', dbSnapshot_licenseModel - License model information for the restored DB instance.

$sel:masterUsername:DBSnapshot', dbSnapshot_masterUsername - Provides the master username for the DB snapshot.

$sel:optionGroupName:DBSnapshot', dbSnapshot_optionGroupName - Provides the option group name for the DB snapshot.

$sel:originalSnapshotCreateTime:DBSnapshot', dbSnapshot_originalSnapshotCreateTime - Specifies the time of the CreateDBSnapshot operation in Coordinated Universal Time (UTC). Doesn't change when the snapshot is copied.

$sel:percentProgress:DBSnapshot', dbSnapshot_percentProgress - The percentage of the estimated data that has been transferred.

$sel:port:DBSnapshot', dbSnapshot_port - Specifies the port that the database engine was listening on at the time of the snapshot.

$sel:processorFeatures:DBSnapshot', dbSnapshot_processorFeatures - The number of CPU cores and the number of threads per core for the DB instance class of the DB instance when the DB snapshot was created.

$sel:snapshotCreateTime:DBSnapshot', dbSnapshot_snapshotCreateTime - Specifies when the snapshot was taken in Coordinated Universal Time (UTC). Changes for the copy when the snapshot is copied.

$sel:snapshotDatabaseTime:DBSnapshot', dbSnapshot_snapshotDatabaseTime - The timestamp of the most recent transaction applied to the database that you're backing up. Thus, if you restore a snapshot, SnapshotDatabaseTime is the most recent transaction in the restored DB instance. In contrast, originalSnapshotCreateTime specifies the system time that the snapshot completed.

If you back up a read replica, you can determine the replica lag by comparing SnapshotDatabaseTime with originalSnapshotCreateTime. For example, if originalSnapshotCreateTime is two hours later than SnapshotDatabaseTime, then the replica lag is two hours.

$sel:snapshotTarget:DBSnapshot', dbSnapshot_snapshotTarget - Specifies where manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.

$sel:snapshotType:DBSnapshot', dbSnapshot_snapshotType - Provides the type of the DB snapshot.

$sel:sourceDBSnapshotIdentifier:DBSnapshot', dbSnapshot_sourceDBSnapshotIdentifier - The DB snapshot Amazon Resource Name (ARN) that the DB snapshot was copied from. It only has a value in the case of a cross-account or cross-Region copy.

$sel:sourceRegion:DBSnapshot', dbSnapshot_sourceRegion - The Amazon Web Services Region that the DB snapshot was created in or copied from.

$sel:status:DBSnapshot', dbSnapshot_status - Specifies the status of this DB snapshot.

$sel:storageThroughput:DBSnapshot', dbSnapshot_storageThroughput - Specifies the storage throughput for the DB snapshot.

$sel:storageType:DBSnapshot', dbSnapshot_storageType - Specifies the storage type associated with DB snapshot.

$sel:tagList:DBSnapshot', dbSnapshot_tagList - Undocumented member.

$sel:tdeCredentialArn:DBSnapshot', dbSnapshot_tdeCredentialArn - The ARN from the key store with which to associate the instance for TDE encryption.

$sel:timezone:DBSnapshot', dbSnapshot_timezone - The time zone of the DB snapshot. In most cases, the Timezone element is empty. Timezone content appears only for snapshots taken from Microsoft SQL Server DB instances that were created with a time zone specified.

$sel:vpcId:DBSnapshot', dbSnapshot_vpcId - Provides the VPC ID associated with the DB snapshot.

Specifies the allocated storage size in gibibytes (GiB).

Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot.

Specifies the DB instance identifier of the DB instance this DB snapshot was created from.

The Amazon Resource Name (ARN) for the DB snapshot.

Specifies the identifier for the DB snapshot.

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 DB snapshot is encrypted.

Specifies the name of the database engine.

Specifies the version of the database engine.

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

Specifies the time in Coordinated Universal Time (UTC) when the DB instance, from which the snapshot was taken, was created.

Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.

If Encrypted is true, the Amazon Web Services KMS key identifier for the encrypted DB snapshot.

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 restored DB instance.

Provides the master username for the DB snapshot.

Provides the option group name for the DB snapshot.

Specifies the time of the CreateDBSnapshot operation in Coordinated Universal Time (UTC). Doesn't change when the snapshot is copied.

The percentage of the estimated data that has been transferred.

Specifies the port that the database engine was listening on at the time of the snapshot.

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance when the DB snapshot was created.

Specifies when the snapshot was taken in Coordinated Universal Time (UTC). Changes for the copy when the snapshot is copied.

The timestamp of the most recent transaction applied to the database that you're backing up. Thus, if you restore a snapshot, SnapshotDatabaseTime is the most recent transaction in the restored DB instance. In contrast, originalSnapshotCreateTime specifies the system time that the snapshot completed.

If you back up a read replica, you can determine the replica lag by comparing SnapshotDatabaseTime with originalSnapshotCreateTime. For example, if originalSnapshotCreateTime is two hours later than SnapshotDatabaseTime, then the replica lag is two hours.

Specifies where manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.

Provides the type of the DB snapshot.

The DB snapshot Amazon Resource Name (ARN) that the DB snapshot was copied from. It only has a value in the case of a cross-account or cross-Region copy.

The Amazon Web Services Region that the DB snapshot was created in or copied from.

Specifies the status of this DB snapshot.

Specifies the storage throughput for the DB snapshot.

Specifies the storage type associated with DB snapshot.

Undocumented member.

The ARN from the key store with which to associate the instance for TDE encryption.

The time zone of the DB snapshot. In most cases, the Timezone element is empty. Timezone content appears only for snapshots taken from Microsoft SQL Server DB instances that were created with a time zone specified.

Provides the VPC ID associated with the DB snapshot.