DbInstance
Detailed information about an instance.
Types
Properties
Does not apply. This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.
Specifies the name of the Availability Zone that the instance is located in.
Specifies the number of days for which automatic snapshots are retained.
The identifier of the CA certificate for this DB instance.
The details of the DB instance's server certificate.
A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.
Contains the name of the cluster that the instance is a member of if the instance is a member of a cluster.
The Amazon Resource Name (ARN) for the instance.
Contains the name of the compute and memory capacity class of the instance.
Contains a user-provided database identifier. This identifier is the unique key that identifies an instance.
Specifies the current state of this database.
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.
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.
Indicates the database engine version.
Provides the date and time that the instance was created.
Specifies the latest time to which a database can be restored with point-in-time restore.
Specifies that changes to the instance are pending. This element is included only when changes are pending. Specific changes are identified by subelements.
Set to true
if Amazon RDS Performance Insights is enabled for the DB instance, and otherwise false
.
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.
Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod
.
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
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.
Not supported. Amazon DocumentDB does not currently support public endpoints. The value of PubliclyAccessible
is always false
.
The status of a read replica. If the instance is not a read replica, this is blank.
Specifies whether or not the instance is encrypted.
Provides a list of VPC security group elements that the instance belongs to.