Skip to main content
Sponsor @cloudposse

Module: documentdb-cluster

Terraform module to provision an Amazon DocumentDB cluster.

Usage​

For a complete example, see examples/complete.

For automated tests of the complete example using bats and Terratest (which tests and deploys the example on AWS), see test.

module "documentdb_cluster" {
  source = "cloudposse/documentdb-cluster/aws"
  # Cloud Posse recommends pinning every module to a specific version
  # version = "x.x.x"
  namespace               = "eg"
  stage                   = "testing"
  name                    = "docdb"
  cluster_size            = 3
  master_username         = "admin1"
  master_password         = "Test123456789"
  instance_class          = "db.r4.large"
  vpc_id                  = "vpc-xxxxxxxx"
  subnet_ids              = ["subnet-xxxxxxxx", "subnet-yyyyyyyy"]
  allowed_security_groups = ["sg-xxxxxxxx"]
  zone_id                 = "Zxxxxxxxx"
}

Variables​

Required Variables​

subnet_ids (list(string)) required

List of VPC subnet IDs to place DocumentDB instances in

vpc_id (string) required

VPC ID to create the cluster in (e.g. vpc-a22222ee)

Optional Variables​

allow_ingress_from_self (bool) optional

Adds the Document DB security group itself as a source for ingress rules. Useful when this security group will be shared with applications.


Default value: false

allow_major_version_upgrade (bool) optional

Specifies whether major version upgrades are allowed. See https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/docdb_cluster#allow_major_version_upgrade


Default value: false

allowed_cidr_blocks (list(string)) optional

List of CIDR blocks to be allowed to connect to the DocumentDB cluster


Default value: [ ]

allowed_egress_cidr_blocks (list(string)) optional

List of CIDR blocks to be allowed to send traffic outside of the DocumentDB cluster


Default value:

[
  "0.0.0.0/0"
]
allowed_security_groups (list(string)) optional

List of existing Security Groups to be allowed to connect to the DocumentDB cluster


Default value: [ ]

apply_immediately (bool) optional

Specifies whether any cluster modifications are applied immediately, or during the next maintenance window


Default value: true

auto_minor_version_upgrade (bool) optional

Specifies whether any minor engine upgrades will be applied automatically to the DB instance during the maintenance window or not


Default value: true

ca_cert_identifier (string) optional

The identifier of the CA certificate for the DB instance


Default value: null

cluster_dns_name (string) optional

Name of the cluster CNAME record to create in the parent DNS zone specified by zone_id. If left empty, the name will be auto-asigned using the format master.var.name


Default value: ""

cluster_family (string) optional

The family of the DocumentDB cluster parameter group. For more details, see https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-parameter-group-create.html


Default value: "docdb3.6"

cluster_parameters optional

List of DB parameters to apply


Type:

list(object({
apply_method = string
name         = string
value        = string
}))

Default value: [ ]

cluster_size (number) optional

Number of DB instances to create in the cluster


Default value: 3

db_port (number) optional

DocumentDB port


Default value: 27017

deletion_protection (bool) optional

A value that indicates whether the DB cluster has deletion protection enabled


Default value: false

egress_from_port (number) optional

[from_port]DocumentDB initial port range for egress (e.g. 0)


Default value: 0

egress_protocol (string) optional

DocumentDB protocol for egress (e.g. -1, tcp)


Default value: "-1"

egress_to_port (number) optional

[to_port]DocumentDB initial port range for egress (e.g. 65535)


Default value: 0

enable_performance_insights (bool) optional

Specifies whether to enable Performance Insights for the DB Instance.


Default value: false

enabled_cloudwatch_logs_exports (list(string)) optional

List of log types to export to cloudwatch. The following log types are supported: audit, profiler


Default value: [ ]

engine (string) optional

The name of the database engine to be used for this DB cluster. Defaults to docdb. Valid values: docdb


Default value: "docdb"

engine_version (string) optional

The version number of the database engine to use


Default value: "3.6.0"

external_security_group_id_list (list(string)) optional

List of external security group IDs to attach to the Document DB


Default value: [ ]

instance_class (string) optional

The instance class to use. For more details, see https://docs.aws.amazon.com/documentdb/latest/developerguide/db-instance-classes.html#db-instance-class-specs


Default value: "db.r4.large"

kms_key_id (string) optional

The ARN for the KMS encryption key. When specifying kms_key_id, storage_encrypted needs to be set to true


Default value: ""

manage_master_user_password (bool) optional

Whether to manage the master user password using AWS Secrets Manager.


Default value: null

master_password (string) optional

(Required unless a snapshot_identifier is provided) Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file. Please refer to the DocumentDB Naming Constraints


Default value: null

master_username (string) optional

(Required unless a snapshot_identifier is provided) Username for the master DB user


Default value: "admin1"

preferred_backup_window (string) optional

Daily time range during which the backups happen


Default value: "07:00-09:00"

preferred_maintenance_window (string) optional

The window to perform maintenance in. Syntax: ddd:hh24:mi-ddd:hh24:mi.


Default value: "Mon:22:00-Mon:23:00"

reader_dns_name (string) optional

Name of the reader endpoint CNAME record to create in the parent DNS zone specified by zone_id. If left empty, the name will be auto-asigned using the format replicas.var.name


Default value: ""

retention_period (number) optional

Number of days to retain backups for


Default value: 5

serverless_v2_scaling_configuration optional

Configuration for serverless v2 scaling. See https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/docdb_cluster#serverless_v2_scaling_configuration


Type:

object({
min_capacity = optional(number, 0.5)
max_capacity = optional(number, 256)
})

Default value: null

skip_final_snapshot (bool) optional

Determines whether a final DB snapshot is created before the DB cluster is deleted


Default value: true

snapshot_identifier (string) optional

Specifies whether or not to create this cluster from a snapshot. You can use either the name or ARN when specifying a DB cluster snapshot, or the ARN when specifying a DB snapshot


Default value: ""

ssm_parameter_enabled (bool) optional

Whether an SSM parameter store value is created to store the database password.


Default value: false

ssm_parameter_path_prefix (string) optional

The path prefix for the created SSM parameter e.g. '/docdb/master-password/dev'. ssm_parameter_enabled must be set to true for this to take affect.


Default value: "/docdb/master-password/"

storage_encrypted (bool) optional

Specifies whether the DB cluster is encrypted


Default value: true

storage_type (string) optional

The storage type to associate with the DB cluster. Valid values: standard, iopt1


Default value: "standard"

zone_id (string) optional

Route53 parent zone ID. If provided (not empty), the module will create sub-domain DNS records for the DocumentDB master and replicas


Default value: ""

Context Variables​

The following variables are defined in the context.tf file of this module and part of the terraform-null-label pattern.

additional_tag_map (map(string)) optional

Additional key-value pairs to add to each map in tags_as_list_of_maps. Not added to tags or id.
This is for some rare cases where resources want additional configuration of tags
and therefore take a list of maps with tag key, value, and additional configuration.


Required: No

Default value: { }

attributes (list(string)) optional

ID element. Additional attributes (e.g. workers or cluster) to add to id,
in the order they appear in the list. New attributes are appended to the
end of the list. The elements of the list are joined by the delimiter
and treated as a single ID element.


Required: No

Default value: [ ]

context (any) optional

Single object for setting entire context at once.
See description of individual variables for details.
Leave string and numeric variables as null to use default value.
Individual variable settings (non-null) override settings in context object,
except for attributes, tags, and additional_tag_map, which are merged.


Required: No

Default value:

{
  "additional_tag_map": {},
  "attributes": [],
  "delimiter": null,
  "descriptor_formats": {},
  "enabled": true,
  "environment": null,
  "id_length_limit": null,
  "label_key_case": null,
  "label_order": [],
  "label_value_case": null,
  "labels_as_tags": [
    "unset"
  ],
  "name": null,
  "namespace": null,
  "regex_replace_chars": null,
  "stage": null,
  "tags": {},
  "tenant": null
}
delimiter (string) optional

Delimiter to be used between ID elements.
Defaults to - (hyphen). Set to "" to use no delimiter at all.


Required: No

Default value: null

descriptor_formats (any) optional

Describe additional descriptors to be output in the descriptors output map.
Map of maps. Keys are names of descriptors. Values are maps of the form
\{<br/> format = string<br/> labels = list(string)<br/> \}
(Type is any so the map values can later be enhanced to provide additional options.)
format is a Terraform format string to be passed to the format() function.
labels is a list of labels, in order, to pass to format() function.
Label values will be normalized before being passed to format() so they will be
identical to how they appear in id.
Default is {} (descriptors output will be empty).


Required: No

Default value: { }

enabled (bool) optional

Set to false to prevent the module from creating any resources
Required: No

Default value: null

environment (string) optional

ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'
Required: No

Default value: null

id_length_limit (number) optional

Limit id to this many characters (minimum 6).
Set to 0 for unlimited length.
Set to null for keep the existing setting, which defaults to 0.
Does not affect id_full.


Required: No

Default value: null

label_key_case (string) optional

Controls the letter case of the tags keys (label names) for tags generated by this module.
Does not affect keys of tags passed in via the tags input.
Possible values: lower, title, upper.
Default value: title.


Required: No

Default value: null

label_order (list(string)) optional

The order in which the labels (ID elements) appear in the id.
Defaults to ["namespace", "environment", "stage", "name", "attributes"].
You can omit any of the 6 labels ("tenant" is the 6th), but at least one must be present.


Required: No

Default value: null

label_value_case (string) optional

Controls the letter case of ID elements (labels) as included in id,
set as tag values, and output by this module individually.
Does not affect values of tags passed in via the tags input.
Possible values: lower, title, upper and none (no transformation).
Set this to title and set delimiter to "" to yield Pascal Case IDs.
Default value: lower.


Required: No

Default value: null

labels_as_tags (set(string)) optional

Set of labels (ID elements) to include as tags in the tags output.
Default is to include all labels.
Tags with empty values will not be included in the tags output.
Set to [] to suppress all generated tags.
Notes:
The value of the name tag, if included, will be the id, not the name.
Unlike other null-label inputs, the initial setting of labels_as_tags cannot be
changed in later chained modules. Attempts to change it will be silently ignored.


Required: No

Default value:

[
  "default"
]
name (string) optional

ID element. Usually the component or solution name, e.g. 'app' or 'jenkins'.
This is the only ID element not also included as a tag.
The "name" tag is set to the full id string. There is no tag with the value of the name input.


Required: No

Default value: null

namespace (string) optional

ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique
Required: No

Default value: null

regex_replace_chars (string) optional

Terraform regular expression (regex) string.
Characters matching the regex will be removed from the ID elements.
If not set, "/[^a-zA-Z0-9-]/" is used to remove all characters other than hyphens, letters and digits.


Required: No

Default value: null

stage (string) optional

ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'
Required: No

Default value: null

tags (map(string)) optional

Additional tags (e.g. {'BusinessUnit': 'XYZ'}).
Neither the tag keys nor the tag values will be modified by this module.


Required: No

Default value: { }

tenant (string) optional

ID element (Rarely used, not included by default). A customer identifier, indicating who this instance of a resource is for
Required: No

Default value: null

Outputs​

arn

Amazon Resource Name (ARN) of the cluster

cluster_members

List of DocumentDB Instances that are a part of this cluster

cluster_name

Cluster Identifier

endpoint

Endpoint of the DocumentDB cluster

master_host

DB master hostname

master_password

Password for the master DB user. If manage_master_user_password is set to true, this will be set to null and the password is managed by AWS in Secrets Manager.

master_username

Username for the master DB user

reader_endpoint

A read-only endpoint of the DocumentDB cluster, automatically load-balanced across replicas

replicas_host

DB replicas hostname

security_group_arn

ARN of the DocumentDB cluster Security Group

security_group_id

ID of the DocumentDB cluster Security Group

security_group_name

Name of the DocumentDB cluster Security Group

Dependencies​

Requirements​

  • terraform, version: >= 1.3
  • aws, version: >= 6.8.0
  • local, version: >= 1.3
  • random, version: >= 1.0

Providers​

  • aws, version: >= 6.8.0
  • random, version: >= 1.0

Modules​

NameVersionSourceDescription
dns_master0.13.0cloudposse/route53-cluster-hostname/awsn/a
dns_replicas0.13.0cloudposse/route53-cluster-hostname/awsn/a
ssm_write_db_password0.13.0cloudposse/ssm-parameter-store/awsn/a
this0.25.0cloudposse/label/nulln/a

Resources​

The following resources are used by this module:

Data Sources​

The following data sources are used by this module: