Terraform module to provision an Amazon DocumentDB cluster.

Tip

👽 Use Atmos with Terraform

Cloud Posse uses atmos to easily orchestrate multiple environments using Terraform.
Works with Github Actions, Atlantis, or Spacelift.

Watch demo of using Atmos with Terraform

Example of running atmos to manage infrastructure from our Quick Start tutorial.

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"
}

Important

In Cloud Posse's examples, we avoid pinning modules to specific versions to prevent discrepancies between the documentation and the latest released versions. However, for your own projects, we strongly advise pinning each module to the exact version you're using. This practice ensures the stability of your infrastructure. Additionally, we recommend implementing a systematic approach for updating versions to avoid unexpected changes.

Makefile Targets

Available targets:

  help                                Help screen
  help/all                            Display help for all targets
  help/short                          This help short screen
  lint                                Lint terraform code

Requirements

Name	Version
terraform	>= 1.3
aws	>= 5.29.0
local	>= 1.3
random	>= 1.0

Providers

Name	Version
aws	>= 5.29.0
random	>= 1.0

Modules

Name	Source	Version
dns_master	cloudposse/route53-cluster-hostname/aws	0.13.0
dns_replicas	cloudposse/route53-cluster-hostname/aws	0.13.0
ssm_write_db_password	cloudposse/ssm-parameter-store/aws	0.13.0
this	cloudposse/label/null	0.25.0

Resources

Name	Type
aws_docdb_cluster.default	resource
aws_docdb_cluster_instance.default	resource
aws_docdb_cluster_parameter_group.default	resource
aws_docdb_subnet_group.default	resource
aws_security_group.default	resource
aws_security_group_rule.allow_ingress_from_self	resource
aws_security_group_rule.egress	resource
aws_security_group_rule.ingress_cidr_blocks	resource
aws_security_group_rule.ingress_security_groups	resource
random_password.password	resource

Inputs

Name	Description	Type	Default	Required
additional_tag_map	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.	map(string)	{}	no
allow_ingress_from_self	Adds the Document DB security group itself as a source for ingress rules. Useful when this security group will be shared with applications.	bool	false	no
allow_major_version_upgrade	Specifies whether major version upgrades are allowed. See https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/docdb_cluster#allow_major_version_upgrade	bool	false	no
allowed_cidr_blocks	List of CIDR blocks to be allowed to connect to the DocumentDB cluster	list(string)	[]	no
allowed_egress_cidr_blocks	List of CIDR blocks to be allowed to send traffic outside of the DocumentDB cluster	list(string)	[ "0.0.0.0/0" ]	no
allowed_security_groups	List of existing Security Groups to be allowed to connect to the DocumentDB cluster	list(string)	[]	no
apply_immediately	Specifies whether any cluster modifications are applied immediately, or during the next maintenance window	bool	true	no
attributes	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.	list(string)	[]	no
auto_minor_version_upgrade	Specifies whether any minor engine upgrades will be applied automatically to the DB instance during the maintenance window or not	bool	true	no
ca_cert_identifier	The identifier of the CA certificate for the DB instance	string	null	no
cluster_dns_name	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	string	""	no
cluster_family	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	string	"docdb3.6"	no
cluster_parameters	List of DB parameters to apply	list(object({ apply_method = string name = string value = string }))	[]	no
cluster_size	Number of DB instances to create in the cluster	number	3	no
context	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.	any	{ "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 }	no
db_port	DocumentDB port	number	27017	no
deletion_protection	A value that indicates whether the DB cluster has deletion protection enabled	bool	false	no
delimiter	Delimiter to be used between ID elements. Defaults to - (hyphen). Set to "" to use no delimiter at all.	string	null	no
descriptor_formats	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).	any	{}	no
egress_from_port	[from_port]DocumentDB initial port range for egress (e.g. 0)	number	0	no
egress_protocol	DocumentDB protocol for egress (e.g. -1, tcp)	string	"-1"	no
egress_to_port	[to_port]DocumentDB initial port range for egress (e.g. 65535)	number	0	no
enable_performance_insights	Specifies whether to enable Performance Insights for the DB Instance.	bool	false	no
enabled	Set to false to prevent the module from creating any resources	bool	null	no
enabled_cloudwatch_logs_exports	List of log types to export to cloudwatch. The following log types are supported: audit, profiler	list(string)	[]	no
engine	The name of the database engine to be used for this DB cluster. Defaults to docdb. Valid values: docdb	string	"docdb"	no
engine_version	The version number of the database engine to use	string	"3.6.0"	no
environment	ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'	string	null	no
external_security_group_id_list	List of external security group IDs to attach to the Document DB	list(string)	[]	no
id_length_limit	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.	number	null	no
instance_class	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	string	"db.r4.large"	no
kms_key_id	The ARN for the KMS encryption key. When specifying kms_key_id, storage_encrypted needs to be set to true	string	""	no
label_key_case	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.	string	null	no
label_order	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.	list(string)	null	no
label_value_case	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.	string	null	no
labels_as_tags	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.	set(string)	[ "default" ]	no
master_password	(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	string	""	no
master_username	(Required unless a snapshot_identifier is provided) Username for the master DB user	string	"admin1"	no
name	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.	string	null	no
namespace	ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique	string	null	no
preferred_backup_window	Daily time range during which the backups happen	string	"07:00-09:00"	no
preferred_maintenance_window	The window to perform maintenance in. Syntax: ddd:hh24:mi-ddd:hh24:mi.	string	"Mon:22:00-Mon:23:00"	no
reader_dns_name	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	string	""	no
regex_replace_chars	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.	string	null	no
retention_period	Number of days to retain backups for	number	5	no
skip_final_snapshot	Determines whether a final DB snapshot is created before the DB cluster is deleted	bool	true	no
snapshot_identifier	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	string	""	no
ssm_parameter_enabled	Whether an SSM parameter store value is created to store the database password.	bool	false	no
ssm_parameter_path_prefix	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.	string	"/docdb/master-password/"	no
stage	ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'	string	null	no
storage_encrypted	Specifies whether the DB cluster is encrypted	bool	true	no
storage_type	The storage type to associate with the DB cluster. Valid values: standard, iopt1	string	"standard"	no
subnet_ids	List of VPC subnet IDs to place DocumentDB instances in	list(string)	n/a	yes
tags	Additional tags (e.g. {'BusinessUnit': 'XYZ'}). Neither the tag keys nor the tag values will be modified by this module.	map(string)	{}	no
tenant	ID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is for	string	null	no
vpc_id	VPC ID to create the cluster in (e.g. vpc-a22222ee)	string	n/a	yes
zone_id	Route53 parent zone ID. If provided (not empty), the module will create sub-domain DNS records for the DocumentDB master and replicas	string	""	no

Outputs

Name	Description
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
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

Related Projects

Check out these related projects.

• terraform-aws-rds - Terraform module to provision AWS RDS instances for MySQL or Postgres
• terraform-aws-rds-cluster - Terraform module to provision an RDS Aurora cluster for MySQL or Postgres
• terraform-aws-rds-cloudwatch-sns-alarms - Terraform module that configures important RDS alerts using CloudWatch and sends them to an SNS topic

References

For additional context, refer to some of these links.

• Creating an Amazon DocumentDB Cluster - official AWS documentation on how to create a DocumentDB cluster
• Amazon DocumentDB Instance Class Specifications - provides details of the Amazon DocumentDB instance classes
• Creating an Amazon DocumentDB Cluster Parameter Group - official AWS documentation on how to create an Amazon DocumentDB Cluster Parameter Group
• Amazon DocumentDB Limits - describes the resource limits and naming constraints for Amazon DocumentDB
• Understanding Amazon DocumentDB Amazon Resource Names (ARNs) - describes ARN formats for DocumentDB resources
• Amazon DocumentDB Parameters - lists all the parameters that are specific to a DocumentDB cluster
• Tagging Amazon DocumentDB Resources - describes how to use tags to add metadata to DocumentDB resources
• Amazon DocumentDB FAQs - DocumentDB frequently asked questions
• Troubleshooting Amazon DocumentDB - provides information about how to troubleshoot problems that you might encounter when using Amazon DocumentDB

Tip

Use Terraform Reference Architectures for AWS

Use Cloud Posse's ready-to-go terraform architecture blueprints for AWS to get up and running quickly.

✅ We build it together with your team.
✅ Your team owns everything.
✅ 100% Open Source and backed by fanatical support.

📚 Learn More

Cloud Posse is the leading DevOps Accelerator for funded startups and enterprises.

Your team can operate like a pro today.

Ensure that your team succeeds by using Cloud Posse's proven process and turnkey blueprints. Plus, we stick around until you succeed.

Day-0: Your Foundation for Success

• Reference Architecture. You'll get everything you need from the ground up built using 100% infrastructure as code.
• Deployment Strategy. Adopt a proven deployment strategy with GitHub Actions, enabling automated, repeatable, and reliable software releases.
• Site Reliability Engineering. Gain total visibility into your applications and services with Datadog, ensuring high availability and performance.
• Security Baseline. Establish a secure environment from the start, with built-in governance, accountability, and comprehensive audit logs, safeguarding your operations.
• GitOps. Empower your team to manage infrastructure changes confidently and efficiently through Pull Requests, leveraging the full power of GitHub Actions.

Day-2: Your Operational Mastery

• Training. Equip your team with the knowledge and skills to confidently manage the infrastructure, ensuring long-term success and self-sufficiency.
• Support. Benefit from a seamless communication over Slack with our experts, ensuring you have the support you need, whenever you need it.
• Troubleshooting. Access expert assistance to quickly resolve any operational challenges, minimizing downtime and maintaining business continuity.
• Code Reviews. Enhance your team’s code quality with our expert feedback, fostering continuous improvement and collaboration.
• Bug Fixes. Rely on our team to troubleshoot and resolve any issues, ensuring your systems run smoothly.
• Migration Assistance. Accelerate your migration process with our dedicated support, minimizing disruption and speeding up time-to-value.
• Customer Workshops. Engage with our team in weekly workshops, gaining insights and strategies to continuously improve and innovate.

✨ Contributing

This project is under active development, and we encourage contributions from our community.

Many thanks to our outstanding contributors:

For 🐛 bug reports & feature requests, please use the issue tracker.

In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.

1. Review our Code of Conduct and Contributor Guidelines.
2. Fork the repo on GitHub
3. Clone the project to your own machine
4. Commit changes to your own branch
5. Push your work back up to your fork
6. Submit a Pull Request so that we can review your changes

NOTE: Be sure to merge the latest changes from "upstream" before making a pull request!

🌎 Slack Community

Join our Open Source Community on Slack. It's FREE for everyone! Our "SweetOps" community is where you get to talk with others who share a similar vision for how to rollout and manage infrastructure. This is the best place to talk shop, ask questions, solicit feedback, and work together as a community to build totally sweet infrastructure.

📰 Newsletter

Sign up for our newsletter and join 3,000+ DevOps engineers, CTOs, and founders who get insider access to the latest DevOps trends, so you can always stay in the know. Dropped straight into your Inbox every week — and usually a 5-minute read.

📆 Office Hours

Join us every Wednesday via Zoom for your weekly dose of insider DevOps trends, AWS news and Terraform insights, all sourced from our SweetOps community, plus a live Q&A that you can’t find anywhere else. It's FREE for everyone!

License

Preamble to the Apache License, Version 2.0

Complete license is available in the LICENSE file.

Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements.  See the NOTICE file
distributed with this work for additional information
regarding copyright ownership.  The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License.  You may obtain a copy of the License at

  https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied.  See the License for the
specific language governing permissions and limitations
under the License.

Trademarks

All other trademarks referenced herein are the property of their respective owners.

---

Copyright © 2017-2024 Cloud Posse, LLC