DbInstance

Detailed information about an instance.

Types

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

Properties

Link copied to clipboard

Does not apply. This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.

Link copied to clipboard

Specifies the name of the Availability Zone that the instance is located in.

Link copied to clipboard

Specifies the number of days for which automatic snapshots are retained.

Link copied to clipboard

The identifier of the CA certificate for this DB instance.

Link copied to clipboard

The details of the DB instance's server certificate.

Link copied to clipboard

A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.

Link copied to clipboard

Contains the name of the cluster that the instance is a member of if the instance is a member of a cluster.

Link copied to clipboard

The Amazon Resource Name (ARN) for the instance.

Link copied to clipboard

Contains the name of the compute and memory capacity class of the instance.

Link copied to clipboard

Contains a user-provided database identifier. This identifier is the unique key that identifies an instance.

Link copied to clipboard

Specifies the current state of this database.

Link copied to clipboard

The Amazon Web Services Region-unique, immutable identifier for the instance. This identifier is found in CloudTrail log entries whenever the KMS key for the instance is accessed.

Link copied to clipboard

Specifies information on the subnet group that is associated with the instance, including the name, description, and subnets in the subnet group.

Link copied to clipboard

A list of log types that this instance is configured to export to CloudWatch Logs.

Link copied to clipboard

Specifies the connection endpoint.

Link copied to clipboard

Provides the name of the database engine to be used for this instance.

Link copied to clipboard

Indicates the database engine version.

Link copied to clipboard

Provides the date and time that the instance was created.

Link copied to clipboard

If StorageEncrypted is true, the KMS key identifier for the encrypted instance.

Link copied to clipboard

Specifies the latest time to which a database can be restored with point-in-time restore.

Link copied to clipboard

Specifies that changes to the instance are pending. This element is included only when changes are pending. Specific changes are identified by subelements.

Link copied to clipboard

Set to true if Amazon RDS Performance Insights is enabled for the DB instance, and otherwise false.

Link copied to clipboard

The KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

Link copied to clipboard

Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

Link copied to clipboard

Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

Link copied to clipboard

A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.

Link copied to clipboard

Not supported. Amazon DocumentDB does not currently support public endpoints. The value of PubliclyAccessible is always false.

Link copied to clipboard

The status of a read replica. If the instance is not a read replica, this is blank.

Link copied to clipboard

Specifies whether or not the instance is encrypted.

Link copied to clipboard

Provides a list of VPC security group elements that the instance belongs to.

Functions

Link copied to clipboard
inline fun copy(block: DbInstance.Builder.() -> Unit = {}): DbInstance
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