Documentation

Detailed information about an instance.

See: newDBInstance smart constructor.

Create a value of DBInstance 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:engineVersion:DBInstance', dbInstance_engineVersion - Indicates the database engine version.

$sel:storageEncrypted:DBInstance', dbInstance_storageEncrypted - Specifies whether or not the instance is encrypted.

$sel:dbClusterIdentifier:DBInstance', dbInstance_dbClusterIdentifier - Contains the name of the cluster that the instance is a member of if the instance is a member of a cluster.

$sel:publiclyAccessible:DBInstance', dbInstance_publiclyAccessible - Not supported. Amazon DocumentDB does not currently support public endpoints. The value of PubliclyAccessible is always false.

$sel:autoMinorVersionUpgrade:DBInstance', dbInstance_autoMinorVersionUpgrade - Does not apply. This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.

$sel:dbInstanceArn:DBInstance', dbInstance_dbInstanceArn - The Amazon Resource Name (ARN) for the instance.

$sel:instanceCreateTime:DBInstance', dbInstance_instanceCreateTime - Provides the date and time that the instance was created.

$sel:engine:DBInstance', dbInstance_engine - Provides the name of the database engine to be used for this instance.

$sel:latestRestorableTime:DBInstance', dbInstance_latestRestorableTime - Specifies the latest time to which a database can be restored with point-in-time restore.

$sel:dbInstanceClass:DBInstance', dbInstance_dbInstanceClass - Contains the name of the compute and memory capacity class of the instance.

$sel:promotionTier:DBInstance', dbInstance_promotionTier - 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.

$sel:preferredMaintenanceWindow:DBInstance', dbInstance_preferredMaintenanceWindow - Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

$sel:cACertificateIdentifier:DBInstance', dbInstance_cACertificateIdentifier - The identifier of the CA certificate for this DB instance.

$sel:dbInstanceIdentifier:DBInstance', dbInstance_dbInstanceIdentifier - Contains a user-provided database identifier. This identifier is the unique key that identifies an instance.

$sel:kmsKeyId:DBInstance', dbInstance_kmsKeyId - If StorageEncrypted is true, the KMS key identifier for the encrypted instance.

$sel:preferredBackupWindow:DBInstance', dbInstance_preferredBackupWindow - Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

$sel:availabilityZone:DBInstance', dbInstance_availabilityZone - Specifies the name of the Availability Zone that the instance is located in.

$sel:vpcSecurityGroups:DBInstance', dbInstance_vpcSecurityGroups - Provides a list of VPC security group elements that the instance belongs to.

$sel:backupRetentionPeriod:DBInstance', dbInstance_backupRetentionPeriod - Specifies the number of days for which automatic snapshots are retained.

$sel:dbSubnetGroup:DBInstance', dbInstance_dbSubnetGroup - Specifies information on the subnet group that is associated with the instance, including the name, description, and subnets in the subnet group.

$sel:enabledCloudwatchLogsExports:DBInstance', dbInstance_enabledCloudwatchLogsExports - A list of log types that this instance is configured to export to CloudWatch Logs.

$sel:dbiResourceId:DBInstance', dbInstance_dbiResourceId - The Region-unique, immutable identifier for the instance. This identifier is found in CloudTrail log entries whenever the KMS key for the instance is accessed.

$sel:endpoint:DBInstance', dbInstance_endpoint - Specifies the connection endpoint.

$sel:dbInstanceStatus:DBInstance', dbInstance_dbInstanceStatus - Specifies the current state of this database.

$sel:pendingModifiedValues:DBInstance', dbInstance_pendingModifiedValues - Specifies that changes to the instance are pending. This element is included only when changes are pending. Specific changes are identified by subelements.

$sel:statusInfos:DBInstance', dbInstance_statusInfos - The status of a read replica. If the instance is not a read replica, this is blank.

Indicates the database engine version.

Specifies whether or not the instance is encrypted.

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

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

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

The Amazon Resource Name (ARN) for the instance.

Provides the date and time that the instance was created.

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

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

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

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.

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

The identifier of the CA certificate for this DB instance.

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

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

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

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

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

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

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

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

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

Specifies the connection endpoint.

Specifies the current state of this database.

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

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