DocDB Instance

This table represents the DocDB Instance resource from Amazon Web Services.

aws.docdb_instance

Fields

TitleIDTypeData TypeDescription
_keycorestring
account_idcorestring
auto_minor_version_upgradecoreboolDoes not apply. This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.
availability_zonecorestringSpecifies the name of the Availability Zone that the instance is located in.
backup_retention_periodcoreint64Specifies the number of days for which automatic snapshots are retained.
ca_certificate_identifiercorestringThe identifier of the CA certificate for this DB instance.
certificate_detailscorejsonThe details of the DB instance's server certificate.
copy_tags_to_snapshotcoreboolA value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.
db_cluster_identifiercorestringContains the name of the cluster that the instance is a member of if the instance is a member of a cluster.
db_instance_arncorestringThe Amazon Resource Name (ARN) for the instance.
db_instance_classcorestringContains the name of the compute and memory capacity class of the instance.
db_instance_identifiercorestringContains a user-provided database identifier. This identifier is the unique key that identifies an instance.
db_instance_statuscorestringSpecifies the current state of this database.
db_subnet_groupcorejsonSpecifies information on the subnet group that is associated with the instance, including the name, description, and subnets in the subnet group.
dbi_resource_idcorestringThe 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.
enabled_cloudwatch_logs_exportscorearray<string>A list of log types that this instance is configured to export to CloudWatch Logs.
endpointcorejsonSpecifies the connection endpoint.
enginecorestringProvides the name of the database engine to be used for this instance.
engine_versioncorestringIndicates the database engine version.
instance_create_timecoretimestampProvides the date and time that the instance was created.
kms_key_idcorestringIf <code>StorageEncrypted</code> is <code>true</code>, the KMS key identifier for the encrypted instance.
latest_restorable_timecoretimestampSpecifies the latest time to which a database can be restored with point-in-time restore.
pending_modified_valuescorejsonSpecifies that changes to the instance are pending. This element is included only when changes are pending. Specific changes are identified by subelements.
performance_insights_enabledcoreboolSet to <code>true</code> if Amazon RDS Performance Insights is enabled for the DB instance, and otherwise <code>false</code>.
performance_insights_kms_key_idcorestringThe 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.
preferred_backup_windowcorestringSpecifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the <code>BackupRetentionPeriod</code>.
preferred_maintenance_windowcorestringSpecifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
promotion_tiercoreint64A 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.
publicly_accessiblecoreboolNot supported. Amazon DocumentDB does not currently support public endpoints. The value of <code>PubliclyAccessible</code> is always <code>false</code>.
status_infoscorejsonThe status of a read replica. If the instance is not a read replica, this is blank.
storage_encryptedcoreboolSpecifies whether or not the instance is encrypted.
tagscorehstore
vpc_security_groupscorejsonProvides a list of VPC security group elements that the instance belongs to.