Terraform module to provision an Amazon DocumentDB
cluster.
This project is part of our comprehensive "SweetOps" approach towards DevOps.
It's 100% Open Source and licensed under the APACHE2.
We literally have hundreds of terraform modules that are Open Source and well-maintained. Check them out!
Security scanning is graciously provided by Bridgecrew. Bridgecrew is the leading fully hosted, cloud-native solution providing continuous Terraform security and compliance.
IMPORTANT: We do not pin modules to versions in our examples because of the difficulty of keeping the versions in the documentation in sync with the latest released versions. We highly recommend that in your code you pin the version to the exact version you are using so that your infrastructure remains stable, and update versions in a systematic way so that they do not catch you by surprise.
Also, because of a bug in the Terraform registry (hashicorp/terraform#21417), the registry shows many of our inputs as required when in fact they are optional. The table below correctly indicates which inputs are required.
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"
}
Available targets:
help Help screen
help/all Display help for all targets
help/short This help short screen
lint Lint terraform code
Name | Version |
---|---|
terraform | >= 0.13.0 |
aws | >= 2.0 |
local | >= 1.3 |
Name | Version |
---|---|
aws | >= 2.0 |
Name | Source | Version |
---|---|---|
dns_master | cloudposse/route53-cluster-hostname/aws | 0.12.0 |
dns_replicas | cloudposse/route53-cluster-hostname/aws | 0.12.0 |
this | cloudposse/label/null | 0.24.1 |
Name |
---|
aws_docdb_cluster |
aws_docdb_cluster_instance |
aws_docdb_cluster_parameter_group |
aws_docdb_subnet_group |
aws_security_group |
aws_security_group_rule |
Name | Description | Type | Default | Required |
---|---|---|---|---|
additional_tag_map | Additional tags for appending to tags_as_list_of_maps. Not added to tags . |
map(string) |
{} |
no |
allowed_cidr_blocks | List of CIDR blocks to be allowed to connect to the DocumentDB cluster | list(string) |
[] |
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 | Additional attributes (e.g. 1 ) |
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 |
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({ |
[] |
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 |
{ |
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 namespace , environment , stage , name and attributes .Defaults to - (hyphen). Set to "" to use no delimiter at all. |
string |
null |
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 , error , general , slowquery |
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 |
"" |
no |
environment | Environment, e.g. 'uw2', 'us-west-2', OR 'prod', 'staging', 'dev', 'UAT' | string |
null |
no |
id_length_limit | Limit id to this many characters (minimum 6).Set to 0 for unlimited length.Set to null for default, which is 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 | The letter case of label keys (tag names) (i.e. name , namespace , environment , stage , attributes ) to use in tags .Possible values: lower , title , upper .Default value: title . |
string |
null |
no |
label_order | The naming order of the id output and Name tag. Defaults to ["namespace", "environment", "stage", "name", "attributes"]. You can omit any of the 5 elements, but at least one must be present. |
list(string) |
null |
no |
label_value_case | The letter case of output label values (also used in tags and id ).Possible values: lower , title , upper and none (no transformation).Default value: lower . |
string |
null |
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 | Solution name, e.g. 'app' or 'jenkins' | string |
null |
no |
namespace | Namespace, which could be your organization name or abbreviation, e.g. 'eg' or 'cp' | 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 | Regex to replace chars with empty string in namespace , environment , stage and name .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 |
stage | Stage, e.g. 'prod', 'staging', 'dev', OR 'source', 'build', 'test', 'deploy', 'release' | string |
null |
no |
storage_encrypted | Specifies whether the DB cluster is encrypted | bool |
true |
no |
subnet_ids | List of VPC subnet IDs to place DocumentDB instances in | list(string) |
n/a | yes |
tags | Additional tags (e.g. map('BusinessUnit','XYZ') |
map(string) |
{} |
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 |
Name | Description |
---|---|
arn | Amazon Resource Name (ARN) of the cluster |
cluster_name | Cluster Identifier |
endpoint | Endpoint of the DocumentDB cluster |
master_host | DB master hostname |
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 |
Like this project? Please give it a ★ on our GitHub! (it helps us a lot)
Are you using this project or any of our other projects? Consider leaving a testimonial. =)
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
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
Got a question? We got answers.
File a GitHub issue, send us an email or join our Slack Community.
We are a DevOps Accelerator. We'll help you build your cloud infrastructure from the ground up so you can own it. Then we'll show you how to operate it and stick around for as long as you need us.
Work directly with our team of DevOps experts via email, slack, and video conferencing.
We deliver 10x the value for a fraction of the cost of a full-time engineer. Our track record is not even funny. If you want things done right and you need it done FAST, then we're your best bet.
- Reference Architecture. You'll get everything you need from the ground up built using 100% infrastructure as code.
- Release Engineering. You'll have end-to-end CI/CD with unlimited staging environments.
- Site Reliability Engineering. You'll have total visibility into your apps and microservices.
- Security Baseline. You'll have built-in governance with accountability and audit logs for all changes.
- GitOps. You'll be able to operate your infrastructure via Pull Requests.
- Training. You'll receive hands-on training so your team can operate what we build.
- Questions. You'll have a direct line of communication between our teams via a Shared Slack channel.
- Troubleshooting. You'll get help to triage when things aren't working.
- Code Reviews. You'll receive constructive feedback on Pull Requests.
- Bug Fixes. We'll rapidly work with you to fix any bugs in our projects.
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.
Participate in our Discourse Forums. Here you'll find answers to commonly asked questions. Most questions will be related to the enormous number of projects we support on our GitHub. Come here to collaborate on answers, find solutions, and get ideas about the products and services we value. It only takes a minute to get started! Just sign in with SSO using your GitHub account.
Sign up for our newsletter that covers everything on our technology radar. Receive updates on what we're up to on GitHub as well as awesome new projects we discover.
Join us every Wednesday via Zoom for our weekly "Lunch & Learn" sessions. It's FREE for everyone!
Please use the issue tracker to report any bugs or file feature requests.
If you are interested in being a contributor and want to get involved in developing this project or help out with our other projects, we would love to hear from you! Shoot us an email.
In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
- Fork the repo on GitHub
- Clone the project to your own machine
- Commit changes to your own branch
- Push your work back up to your fork
- 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!
Copyright © 2017-2021 Cloud Posse, LLC
See LICENSE for full details.
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.
All other trademarks referenced herein are the property of their respective owners.
This project is maintained and funded by Cloud Posse, LLC. Like it? Please let us know by leaving a testimonial!
We're a DevOps Professional Services company based in Los Angeles, CA. We ❤️ Open Source Software.
We offer paid support on all of our projects.
Check out our other projects, follow us on twitter, apply for a job, or hire us to help with your cloud strategy and implementation.
Erik Osterman |
Andriy Knysh |
Igor Rodionov |
---|