DocDb Cluster

This table represents the DocDb Cluster resource from Amazon Web Services.

aws.docdb_cluster

Fields

TitleIDTypeData TypeDescription
_keycorestring
account_idcorestring
associated_rolescorejsonProvides a list of the Identity and Access Management (IAM) roles that are associated with the cluster. (IAM) roles that are associated with a cluster grant permission for the cluster to access other Amazon Web Services services on your behalf.
availability_zonescorearray<string>Provides the list of Amazon EC2 Availability Zones that instances in the cluster can be created in.
backup_retention_periodcoreint64Specifies the number of days for which automatic snapshots are retained.
clone_group_idcorestringIdentifies the clone group to which the DB cluster is associated.
cluster_create_timecoretimestampSpecifies the time when the cluster was created, in Universal Coordinated Time (UTC).
db_cluster_arncorestringThe Amazon Resource Name (ARN) for the cluster.
db_cluster_identifiercorestringContains a user-supplied cluster identifier. This identifier is the unique key that identifies a cluster.
db_cluster_memberscorejsonProvides the list of instances that make up the cluster.
db_cluster_parameter_groupcorestringSpecifies the name of the cluster parameter group for the cluster.
db_cluster_resource_idcorestringThe Amazon Web Services Region-unique, immutable identifier for the cluster. This identifier is found in CloudTrail log entries whenever the KMS key for the cluster is accessed.
db_subnet_groupcorestringSpecifies information on the subnet group that is associated with the cluster, including the name, description, and subnets in the subnet group.
deletion_protectioncoreboolSpecifies whether this cluster can be deleted. If <code>DeletionProtection</code> is enabled, the cluster cannot be deleted unless it is modified and <code>DeletionProtection</code> is disabled. <code>DeletionProtection</code> protects clusters from being accidentally deleted.
earliest_restorable_timecoretimestampThe earliest time to which a database can be restored with point-in-time restore.
enabled_cloudwatch_logs_exportscorearray<string>A list of log types that this cluster is configured to export to Amazon CloudWatch Logs.
endpointcorestringSpecifies the connection endpoint for the primary instance of the cluster.
enginecorestringProvides the name of the database engine to be used for this cluster.
engine_versioncorestringIndicates the database engine version.
hosted_zone_idcorestringSpecifies the ID that Amazon Route 53 assigns when you create a hosted zone.
kms_key_idcorestringIf <code>StorageEncrypted</code> is <code>true</code>, the KMS key identifier for the encrypted cluster.
latest_restorable_timecoretimestampSpecifies the latest time to which a database can be restored with point-in-time restore.
master_usernamecorestringContains the master user name for the cluster.
multi_azcoreboolSpecifies whether the cluster has instances in multiple Availability Zones.
percent_progresscorestringSpecifies the progress of the operation as a percentage.
portcoreint64Specifies the port that the database engine is listening on.
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).
read_replica_identifierscorearray<string>Contains one or more identifiers of the secondary clusters that are associated with this cluster.
reader_endpointcorestringThe reader endpoint for the cluster. The reader endpoint for a cluster load balances connections across the Amazon DocumentDB replicas that are available in a cluster. As clients request new connections to the reader endpoint, Amazon DocumentDB distributes the connection requests among the Amazon DocumentDB replicas in the cluster. This functionality can help balance your read workload across multiple Amazon DocumentDB replicas in your cluster. If a failover occurs, and the Amazon DocumentDB replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Amazon DocumentDB replicas in the cluster, you can then reconnect to the reader endpoint.
replication_source_identifiercorestringContains the identifier of the source cluster if this cluster is a secondary cluster.
statuscorestringSpecifies the current state of this cluster.
storage_encryptedcoreboolSpecifies whether the cluster is encrypted.
storage_typecorestringStorage type associated with your cluster Storage type associated with your cluster For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the <i>Amazon DocumentDB Developer Guide</i>. Valid values for storage type - <code>standard | iopt1</code> Default value is <code>standard </code>
tagscorehstore
vpc_security_groupscorejsonProvides a list of virtual private cloud (VPC) security groups that the cluster belongs to.