DocumentDB Elastic Cluster

DocumentDB Elastic Cluster is a fully managed, scalable cluster for Amazon DocumentDB that automatically adjusts capacity to handle variable workloads. It provides elastic scaling of compute and storage, making it easier to run document-based applications without manual provisioning. This resource is designed for high availability, security, and integration with other AWS services, while reducing operational overhead.

aws.docdbelastic_cluster

Fields

TitleIDTypeData TypeDescription
_keycorestring
account_idcorestring
admin_user_namecorestringThe name of the elastic cluster administrator.
auth_typecorestringThe authentication type for the elastic cluster.
backup_retention_periodcoreint64The number of days for which automatic snapshots are retained.
cluster_arncorestringThe ARN identifier of the elastic cluster.
cluster_endpointcorestringThe URL used to connect to the elastic cluster.
cluster_namecorestringThe name of the elastic cluster.
create_timecorestringThe time when the elastic cluster was created in Universal Coordinated Time (UTC).
kms_key_idcorestringThe KMS key identifier to use to encrypt the elastic cluster.
preferred_backup_windowcorestringThe daily time range during which automated backups are created if automated backups are enabled, as determined by backupRetentionPeriod.
preferred_maintenance_windowcorestringThe weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). Format: ddd:hh24:mi-ddd:hh24:mi
shard_capacitycoreint64The number of vCPUs assigned to each elastic cluster shard. Maximum is 64. Allowed values are 2, 4, 8, 16, 32, 64.
shard_countcoreint64The number of shards assigned to the elastic cluster. Maximum is 32.
shard_instance_countcoreint64The number of replica instances applying to all shards in the cluster. A shardInstanceCount value of 1 means there is one writer instance, and any additional instances are replicas that can be used for reads and to improve availability.
shardscorejsonThe total number of shards in the cluster.
statuscorestringThe status of the elastic cluster.
subnet_idscorearray<string>The Amazon EC2 subnet IDs for the elastic cluster.
tagscorehstore
vpc_security_group_idscorearray<string>A list of EC2 VPC security groups associated with thie elastic cluster.