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!
IMPORTANT: The master branch is used in source just as an example. In your code, do not pin to master because there may be breaking changes between releases.
Instead pin to the release tag (e.g. ?ref=tags/x.y.z) of one of our latest releases.
For a complete example, see examples/complete
module "documentdb_cluster" {
source = "git::https://github.com/cloudposse/terraform-aws-documentdb-cluster.git?ref=master"
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 | Description | Type | Default | Required |
|---|---|---|---|---|
| allowed_cidr_blocks | List of CIDR blocks to be allowed to connect to the DocumentDB cluster | list | <list> |
no |
| allowed_security_groups | List of existing Security Groups to be allowed to connect to the DocumentDB cluster | list | <list> |
no |
| apply_immediately | Specifies whether any cluster modifications are applied immediately, or during the next maintenance window | string | true |
no |
| attributes | Additional attributes (e.g. 1) |
list | <list> |
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 | <list> |
no |
| cluster_size | Number of DB instances to create in the cluster | string | 3 |
no |
| db_port | DocumentDB port | string | 27017 |
no |
| delimiter | Delimiter to be used between name, namespace, stage and attributes |
string | - |
no |
| enabled | Set to false to prevent the module from creating any resources | string | true |
no |
| enabled_cloudwatch_logs_exports | List of log types to export to cloudwatch. The following log types are supported: audit, error, general, slowquery. | list | <list> |
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 |
| 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 |
| 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 | Name of the application | string | - | yes |
| namespace | Namespace (e.g. eg or cp) |
string | - | yes |
| preferred_backup_window | Daily time range during which the backups happen | string | 07:00-09: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 |
| retention_period | Number of days to retain backups for | string | 5 |
no |
| skip_final_snapshot | Determines whether a final DB snapshot is created before the DB cluster is deleted | string | 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, dev, staging) |
string | - | yes |
| storage_encrypted | Specifies whether the DB cluster is encrypted | string | true |
no |
| subnet_ids | List of VPC subnet IDs to place DocumentDB instances | list | - | yes |
| tags | Additional tags (e.g. map(BusinessUnit,XYZ) |
map | <map> |
no |
| vpc_id | VPC ID to create the cluster in (e.g. vpc-a22222ee) |
string | - | 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?
File a GitHub issue, send us an email or join our Slack Community.
Work directly with our team of DevOps experts via email, slack, and video conferencing.
We provide commercial support for all of our Open Source projects. As a Dedicated Support customer, you have access to our team of subject matter experts at a fraction of the cost of a full-time engineer.
- Questions. We'll use a Shared Slack channel between your team and ours.
- Troubleshooting. We'll help you triage why things aren't working.
- Code Reviews. We'll review your Pull Requests and provide constructive feedback.
- Bug Fixes. We'll rapidly work to fix any bugs in our projects.
- Build New Terraform Modules. We'll develop original modules to provision infrastructure.
- Cloud Architecture. We'll assist with your cloud strategy and design.
- Implementation. We'll provide hands-on support to implement our reference architectures.
Are you interested in custom Terraform module development? Submit your inquiry using our form today and we'll get back to you ASAP.
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.
Signup 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.
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-2019 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 |
|---|
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent