DBInstance

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

Type: Boolean

Required: No

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

Type: String

Required: No

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

Type: Integer

Required: No

The identifier of the CA certificate for this DB instance.

Type: String

Required: No

The details of the DB instance's server certificate.

Type: CertificateDetails object

Required: No

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

Type: Boolean

Required: No

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

Type: String

Required: No

The Amazon Resource Name (ARN) for the instance.

Type: String

Required: No

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

Type: String

Required: No

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

Type: String

Required: No

Specifies the current state of this database.

Type: String

Required: No

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

Type: String

Required: No

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

Type: DBSubnetGroup object

Required: No

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

Type: Array of strings

Required: No

Specifies the connection endpoint.

Type: Endpoint object

Required: No

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

Type: String

Required: No

Indicates the database engine version.

Type: String

Required: No

Provides the date and time that the instance was created.

Type: Timestamp

Required: No

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

Type: String

Required: No

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

Type: Timestamp

Required: No

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

Type: PendingModifiedValues object

Required: No

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

Type: Boolean

Required: No

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

Type: String

Required: No

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

Type: String

Required: No

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

Type: String

Required: No

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.

Type: Integer

Required: No

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

Type: Boolean

Required: No

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

Type: Array of DBInstanceStatusInfo objects

Required: No

Specifies whether or not the instance is encrypted.

Type: Boolean

Required: No

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

Type: Array of VpcSecurityGroupMembership objects

Required: No