{"id":21725463,"url":"https://github.com/jameswoolfenden/terraform-aws-documentdb","last_synced_at":"2026-04-11T03:11:56.672Z","repository":{"id":81359195,"uuid":"309713434","full_name":"JamesWoolfenden/terraform-aws-documentdb","owner":"JamesWoolfenden","description":"Basic Documentdb module","archived":false,"fork":false,"pushed_at":"2023-04-24T15:46:25.000Z","size":78,"stargazers_count":1,"open_issues_count":0,"forks_count":2,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-01-25T19:28:05.545Z","etag":null,"topics":["aws","module","terraform"],"latest_commit_sha":null,"homepage":"","language":"HCL","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/JamesWoolfenden.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-11-03T14:34:17.000Z","updated_at":"2022-09-19T19:27:33.000Z","dependencies_parsed_at":"2023-07-11T10:35:25.381Z","dependency_job_id":null,"html_url":"https://github.com/JamesWoolfenden/terraform-aws-documentdb","commit_stats":null,"previous_names":[],"tags_count":55,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JamesWoolfenden%2Fterraform-aws-documentdb","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JamesWoolfenden%2Fterraform-aws-documentdb/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JamesWoolfenden%2Fterraform-aws-documentdb/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JamesWoolfenden%2Fterraform-aws-documentdb/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/JamesWoolfenden","download_url":"https://codeload.github.com/JamesWoolfenden/terraform-aws-documentdb/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244706500,"owners_count":20496570,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["aws","module","terraform"],"created_at":"2024-11-26T03:17:48.863Z","updated_at":"2025-12-30T21:25:57.058Z","avatar_url":"https://github.com/JamesWoolfenden.png","language":"HCL","funding_links":[],"categories":[],"sub_categories":[],"readme":"# terraform-aws-documentdb\n\n[![Build Status](https://github.com/JamesWoolfenden/terraform-aws-documentdb/workflows/Verify/badge.svg?branch=master)](https://github.com/JamesWoolfenden/terraform-aws-documentdb)\n[![Latest Release](https://img.shields.io/github/release/JamesWoolfenden/terraform-aws-documentdb.svg)](https://github.com/JamesWoolfenden/terraform-aws-documentdb/releases/latest)\n[![GitHub tag (latest SemVer)](https://img.shields.io/github/tag/JamesWoolfenden/terraform-aws-documentdb.svg?label=latest)](https://github.com/JamesWoolfenden/terraform-aws-documentdb/releases/latest)\n![Terraform Version](https://img.shields.io/badge/tf-%3E%3D0.14.0-blue.svg)\n[![Infrastructure Tests](https://www.bridgecrew.cloud/badges/github/JamesWoolfenden/terraform-aws-documentdb/cis_aws)](https://www.bridgecrew.cloud/link/badge?vcs=github\u0026fullRepo=JamesWoolfenden%2Fterraform-aws-documentdb\u0026benchmark=CIS+AWS+V1.2)\n[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit\u0026logoColor=white)](https://github.com/pre-commit/pre-commit)\n[![checkov](https://img.shields.io/badge/checkov-verified-brightgreen)](https://www.checkov.io/)\n[![Infrastructure Tests](https://www.bridgecrew.cloud/badges/github/jameswoolfenden/terraform-aws-documentdb/general)](https://www.bridgecrew.cloud/link/badge?vcs=github\u0026fullRepo=JamesWoolfenden%2Fterraform-aws-documentdb\u0026benchmark=INFRASTRUCTURE+SECURITY)\n\n---\n\nTerraform module a documentdb. It's 100% Open Source and licensed under the [APACHE2](LICENSE).\n\n## Usage\n\nThis is just a very basic example.\n\n![alt text](./diagram/documentdb.png)\n\nInclude this repository as a module in your existing Terraform code:\n\n```hcl\nmodule \"documentdb\" {\n  source                 = \"jameswoolfenden/documentdb/aws\"\n  common_tags            = var.common_tags\n}\n```\n\n## Costs\n\n```text\nMonthly cost estimate\n\nProject: JamesWoolfenden/terraform-aws-documentdb/example/examplea\n\n Name                                                          Monthly Qty  Unit                Monthly Cost\n\n module.documentdb.aws_docdb_cluster.examplea\n └─ Backup storage                                         Monthly cost depends on usage: $0 per GB\n\n module.documentdb.aws_docdb_cluster_instance.examplea[0]\n ├─ Database instance (on-demand, db.r5.large)                         730  hours                    $237.25\n ├─ Storage                                                Monthly cost depends on usage: $0 per GB\n └─ I/O                                                    Monthly cost depends on usage: $0 per 1M requests\n\n OVERALL TOTAL                                                                                       $237.25\n```\n\n## Detailed Notes\n\n\u003c!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK --\u003e\n## Requirements\n\nNo requirements.\n\n## Providers\n\n| Name | Version |\n|------|---------|\n| \u003ca name=\"provider_aws\"\u003e\u003c/a\u003e [aws](#provider\\_aws) | n/a |\n\n## Modules\n\nNo modules.\n\n## Resources\n\n| Name | Type |\n|------|------|\n| [aws_docdb_cluster.examplea](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/docdb_cluster) | resource |\n| [aws_docdb_cluster_instance.examplea](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/docdb_cluster_instance) | resource |\n| [aws_docdb_cluster_parameter_group.examplea](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/docdb_cluster_parameter_group) | resource |\n| [aws_docdb_subnet_group.examplea](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/docdb_subnet_group) | resource |\n| [aws_availability_zones.available](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/availability_zones) | data source |\n\n## Inputs\n\n| Name | Description | Type | Default | Required |\n|------|-------------|------|---------|:--------:|\n| \u003ca name=\"input_apply_immediately\"\u003e\u003c/a\u003e [apply\\_immediately](#input\\_apply\\_immediately) | n/a | `bool` | `false` | no |\n| \u003ca name=\"input_backup_retention_period\"\u003e\u003c/a\u003e [backup\\_retention\\_period](#input\\_backup\\_retention\\_period) | n/a | `number` | `5` | no |\n| \u003ca name=\"input_change_stream_log_retention_duration\"\u003e\u003c/a\u003e [change\\_stream\\_log\\_retention\\_duration](#input\\_change\\_stream\\_log\\_retention\\_duration) | Defines the duration of time (in seconds) that the change stream log is retained and can be consumed. | `number` | `10800` | no |\n| \u003ca name=\"input_cluster_identifier\"\u003e\u003c/a\u003e [cluster\\_identifier](#input\\_cluster\\_identifier) | n/a | `string` | `\"my-docdb-cluster\"` | no |\n| \u003ca name=\"input_deletion_protection\"\u003e\u003c/a\u003e [deletion\\_protection](#input\\_deletion\\_protection) | n/a | `bool` | `false` | no |\n| \u003ca name=\"input_family\"\u003e\u003c/a\u003e [family](#input\\_family) | n/a | `string` | `\"docdb3.6\"` | no |\n| \u003ca name=\"input_instance-prefix\"\u003e\u003c/a\u003e [instance-prefix](#input\\_instance-prefix) | n/a | `string` | `\"docdb-cluster-demo\"` | no |\n| \u003ca name=\"input_instance_class\"\u003e\u003c/a\u003e [instance\\_class](#input\\_instance\\_class) | n/a | `string` | `\"db.r5.large\"` | no |\n| \u003ca name=\"input_instance_count\"\u003e\u003c/a\u003e [instance\\_count](#input\\_instance\\_count) | n/a | `number` | `1` | no |\n| \u003ca name=\"input_instance_maintenance_window\"\u003e\u003c/a\u003e [instance\\_maintenance\\_window](#input\\_instance\\_maintenance\\_window) | n/a | `string` | `\"Sat:00:00-Sat:03:00\"` | no |\n| \u003ca name=\"input_kms_key_id\"\u003e\u003c/a\u003e [kms\\_key\\_id](#input\\_kms\\_key\\_id) | The ARN of the key to encrypt the db with. | `string` | n/a | yes |\n| \u003ca name=\"input_master_password\"\u003e\u003c/a\u003e [master\\_password](#input\\_master\\_password) | DocumentDB Password | `string` | n/a | yes |\n| \u003ca name=\"input_master_username\"\u003e\u003c/a\u003e [master\\_username](#input\\_master\\_username) | n/a | `string` | `\"docadmin\"` | no |\n| \u003ca name=\"input_param_group_name\"\u003e\u003c/a\u003e [param\\_group\\_name](#input\\_param\\_group\\_name) | n/a | `string` | `\"examplea\"` | no |\n| \u003ca name=\"input_profiler\"\u003e\u003c/a\u003e [profiler](#input\\_profiler) | n/a | `string` | `\"disabled\"` | no |\n| \u003ca name=\"input_profiler_sampling_rate\"\u003e\u003c/a\u003e [profiler\\_sampling\\_rate](#input\\_profiler\\_sampling\\_rate) | Defines the sampling rate for logged operations. | `number` | `1` | no |\n| \u003ca name=\"input_profiler_threshold_ms\"\u003e\u003c/a\u003e [profiler\\_threshold\\_ms](#input\\_profiler\\_threshold\\_ms) | Defines the threshold for profiler | `number` | `100` | no |\n| \u003ca name=\"input_promotion_tier\"\u003e\u003c/a\u003e [promotion\\_tier](#input\\_promotion\\_tier) | n/a | `number` | `0` | no |\n| \u003ca name=\"input_subnet_group_name\"\u003e\u003c/a\u003e [subnet\\_group\\_name](#input\\_subnet\\_group\\_name) | n/a | `string` | `\"docdb\"` | no |\n| \u003ca name=\"input_subnet_list\"\u003e\u003c/a\u003e [subnet\\_list](#input\\_subnet\\_list) | n/a | `list(any)` | n/a | yes |\n| \u003ca name=\"input_ttl_monitor\"\u003e\u003c/a\u003e [ttl\\_monitor](#input\\_ttl\\_monitor) | n/a | `string` | `\"enabled\"` | no |\n\n## Outputs\n\n| Name | Description |\n|------|-------------|\n| \u003ca name=\"output_cluster\"\u003e\u003c/a\u003e [cluster](#output\\_cluster) | n/a |\n| \u003ca name=\"output_instance\"\u003e\u003c/a\u003e [instance](#output\\_instance) | n/a |\n| \u003ca name=\"output_properties\"\u003e\u003c/a\u003e [properties](#output\\_properties) | n/a |\n\u003c!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK --\u003e\n\n## Policy\n\nThis is the policy required to build this project:\n\n\u003c!-- BEGINNING OF PRE-COMMIT-PIKE DOCS HOOK --\u003e\nThe Terraform resource required is:\n\n```golang\nresource \"aws_iam_policy\" \"terraform_pike\" {\n  name_prefix = \"terraform_pike\"\n  path        = \"/\"\n  description = \"Pike Autogenerated policy from IAC\"\n\n  policy = jsonencode({\n    \"Version\": \"2012-10-17\",\n    \"Statement\": [\n        {\n            \"Sid\": \"VisualEditor0\",\n            \"Effect\": \"Allow\",\n            \"Action\": [\n                \"ec2:DescribeAccountAttributes\",\n                \"ec2:DescribeAvailabilityZones\"\n            ],\n            \"Resource\": [\n                \"*\"\n            ]\n        },\n        {\n            \"Sid\": \"VisualEditor1\",\n            \"Effect\": \"Allow\",\n            \"Action\": [\n                \"rds:CreateDBCluster\",\n                \"rds:CreateDBClusterParameterGroup\",\n                \"rds:CreateDBInstance\",\n                \"rds:CreateDBSubnetGroup\",\n                \"rds:DeleteDBCluster\",\n                \"rds:DeleteDBClusterParameterGroup\",\n                \"rds:DeleteDBInstance\",\n                \"rds:DeleteDBSubnetGroup\",\n                \"rds:DescribeDBClusterParameterGroups\",\n                \"rds:DescribeDBClusterParameters\",\n                \"rds:DescribeDBClusters\",\n                \"rds:DescribeDBInstances\",\n                \"rds:DescribeDBSubnetGroups\",\n                \"rds:DescribeGlobalClusters\",\n                \"rds:ListTagsForResource\",\n                \"rds:ModifyDBCluster\",\n                \"rds:ModifyDBClusterParameterGroup\",\n                \"rds:ModifyDBInstance\"\n            ],\n            \"Resource\": [\n                \"*\"\n            ]\n        }\n    ]\n})\n}\n\n\n```\n\u003c!-- END OF PRE-COMMIT-PIKE DOCS HOOK --\u003e\n\n## Related Projects\n\nCheck out these related projects.\n\n- [terraform-aws-codecommit](https://github.com/jameswoolfenden/terraform-aws-codecommit) - Storing ones code\n\n## Help\n\n**Got a question?**\n\nFile a GitHub [issue](https://github.com/jameswoolfenden/terraform-aws-documentdb/issues).\n\n## Contributing\n\n### Bug Reports \u0026 Feature Requests\n\nPlease use the [issue tracker](https://github.com/jameswoolfenden/terraform-aws-documentdb/issues) to report any bugs or file feature requests.\n\n## Copyrights\n\nCopyright © 2019-2023 James Woolfenden\n\n## License\n\n[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)\n\nSee [LICENSE](LICENSE) for full details.\n\nLicensed to the Apache Software Foundation (ASF) under one\nor more contributor license agreements. See the NOTICE file\ndistributed with this work for additional information\nregarding copyright ownership. The ASF licenses this file\nto you under the Apache License, Version 2.0 (the\n\"License\"); you may not use this file except in compliance\nwith the License. You may obtain a copy of the License at\n\n\u003chttps://www.apache.org/licenses/LICENSE-2.0\u003e\n\nUnless required by applicable law or agreed to in writing,\nsoftware distributed under the License is distributed on an\n\"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY\nKIND, either express or implied. See the License for the\nspecific language governing permissions and limitations\nunder the License.\n\n### Contributors\n\n[![James Woolfenden][jameswoolfenden_avatar]][jameswoolfenden_homepage]\u003cbr/\u003e[James Woolfenden][jameswoolfenden_homepage]\n\n[jameswoolfenden_homepage]: https://github.com/jameswoolfenden\n[jameswoolfenden_avatar]: https://github.com/jameswoolfenden.png?size=150\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjameswoolfenden%2Fterraform-aws-documentdb","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjameswoolfenden%2Fterraform-aws-documentdb","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjameswoolfenden%2Fterraform-aws-documentdb/lists"}