Skip to content

Commit

Permalink
add readme
Browse files Browse the repository at this point in the history
  • Loading branch information
drpebcak committed Dec 2, 2019
1 parent c574eee commit ff50ad2
Show file tree
Hide file tree
Showing 2 changed files with 41 additions and 0 deletions.
6 changes: 6 additions & 0 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
- repo: git://github.com/antonbabenko/pre-commit-terraform
rev: v1.19.0
hooks:
- id: terraform_fmt
- id: terraform_docs

35 changes: 35 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
## Terraform AWS DocumentDB Cluster

This terraform module creates a documentDB cluster.

<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
## Inputs

| Name | Description | Type | Default | Required |
|------|-------------|:----:|:-----:|:-----:|
| backup\_retention\_period | | number | `"7"` | no |
| cluster\_instance\_class | | string | `"db.r5.large"` | no |
| cluster\_instance\_count | | number | `"1"` | no |
| cluster\_security\_group | | list(string) | n/a | yes |
| group\_subnets | | list(string) | `[]` | no |
| master\_password | | string | n/a | yes |
| master\_username | | string | n/a | yes |
| name | | string | n/a | yes |
| parameters | additional parameters modified in parameter group | list(map(any)) | `[]` | no |
| preferred\_backup\_window | | string | `"07:00-09:00"` | no |
| skip\_final\_snapshot | | bool | `"false"` | no |
| storage\_encrypted | | bool | `"true"` | no |

## Outputs

| Name | Description |
|------|-------------|
| arn | |
| cluster\_members | |
| cluster\_resource\_id | |
| endpoint | |
| hosted\_zone\_id | |
| id | |
| reader\_endpoint | |

<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->

0 comments on commit ff50ad2

Please sign in to comment.