DbSnapshot

Contains the details of an Amazon RDS DB snapshot.

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

Types

Link copied to clipboard
class Builder
Link copied to clipboard
object Companion

Properties

Link copied to clipboard

Specifies the allocated storage size in gibibytes (GiB).

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Specifies the identifier for the DB snapshot.

Link copied to clipboard

The Oracle system identifier (SID), which is the name of the Oracle database instance that manages your database files. The Oracle SID is also the name of your CDB.

Link copied to clipboard

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

Link copied to clipboard

Indicates whether the DB snapshot is encrypted.

Link copied to clipboard

Specifies the name of the database engine.

Link copied to clipboard

Specifies the version of the database engine.

Link copied to clipboard

Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.

Link copied to clipboard

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

Link copied to clipboard
val iops: Int?

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

Link copied to clipboard

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

Link copied to clipboard

License model information for the restored DB instance.

Link copied to clipboard

Provides the master username for the DB snapshot.

Link copied to clipboard

Indicates whether the snapshot is of a DB instance using the multi-tenant configuration (TRUE) or the single-tenant configuration (FALSE).

Link copied to clipboard

Provides the option group name for the DB snapshot.

Link copied to clipboard

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

Link copied to clipboard

The percentage of the estimated data that has been transferred.

Link copied to clipboard
val port: Int?

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

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

Provides the type of the DB snapshot.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

Specifies the status of this DB snapshot.

Link copied to clipboard

Specifies the storage throughput for the DB snapshot.

Link copied to clipboard

Specifies the storage type associated with DB snapshot.

Link copied to clipboard

A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

Provides the VPC ID associated with the DB snapshot.

Functions

Link copied to clipboard
inline fun copy(block: DbSnapshot.Builder.() -> Unit = {}): DbSnapshot
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
open override fun toString(): String