├── .gitignore ├── .github ├── FUNDING.yml ├── dependabot.yml ├── labels.yml ├── workflows │ ├── release-drafter.yml │ ├── repository.yml │ ├── lint.yml │ ├── action_pull_request.yml │ ├── action_schedule.yml │ ├── action_branch.yml │ └── params.yml └── release-drafter.yml ├── tests ├── output │ ├── generate │ │ ├── 0.12 │ │ │ └── main.tf │ │ ├── basic │ │ │ ├── main.tf │ │ │ ├── TEST-0.1.0.md │ │ │ ├── TEST-0.4.5.md │ │ │ ├── TEST-0.5.0.md │ │ │ ├── TEST-0.6.0.md │ │ │ ├── TEST-0.7.0.md │ │ │ ├── TEST-0.1.1.md │ │ │ ├── TEST-0.2.0.md │ │ │ ├── TEST-0.3.0.md │ │ │ ├── TEST-0.4.0.md │ │ │ ├── TEST-0.8.0.md │ │ │ ├── TEST-0.8.1.md │ │ │ ├── TEST-0.8.2.md │ │ │ ├── TEST-0.10.0.md │ │ │ ├── TEST-0.10.1.md │ │ │ ├── TEST-0.9.0.md │ │ │ ├── TEST-0.9.1.md │ │ │ ├── TEST-0.11.0.md │ │ │ ├── TEST-0.11.1.md │ │ │ ├── TEST-0.11.2.md │ │ │ ├── TEST-0.12.0.md │ │ │ ├── TEST-0.12.1.md │ │ │ ├── TEST-0.13.0.md │ │ │ ├── TEST-0.14.0.md │ │ │ ├── TEST-0.14.1.md │ │ │ ├── TEST-0.15.0.md │ │ │ ├── TEST-0.16.0.md │ │ │ ├── TEST-0.17.0.md │ │ │ ├── TEST-0.18.0.md │ │ │ ├── TEST-0.19.0.md │ │ │ ├── TEST-0.20.0.md │ │ │ └── TEST-latest.md │ │ └── default │ │ │ ├── main.tf │ │ │ ├── TEST-0.1.0.md │ │ │ ├── TEST-0.4.5.md │ │ │ ├── TEST-0.4.0.md │ │ │ ├── TEST-0.5.0.md │ │ │ ├── TEST-0.1.1.md │ │ │ ├── TEST-0.2.0.md │ │ │ ├── TEST-0.3.0.md │ │ │ ├── TEST-0.6.0.md │ │ │ ├── TEST-0.7.0.md │ │ │ ├── TEST-0.8.0.md │ │ │ ├── TEST-0.8.1.md │ │ │ └── TEST-0.8.2.md │ └── replace │ │ ├── 0.12 │ │ └── main.tf │ │ ├── basic │ │ ├── main.tf │ │ ├── TEST-0.1.0.md │ │ ├── TEST-0.4.5.md │ │ ├── TEST-0.5.0.md │ │ ├── TEST-0.6.0.md │ │ ├── TEST-0.7.0.md │ │ ├── TEST-0.1.1.md │ │ ├── TEST-0.2.0.md │ │ ├── TEST-0.3.0.md │ │ ├── TEST-0.4.0.md │ │ ├── TEST-0.8.0.md │ │ ├── TEST-0.8.1.md │ │ ├── TEST-0.8.2.md │ │ ├── TEST-0.10.0.md │ │ ├── TEST-0.10.1.md │ │ ├── TEST-0.9.0.md │ │ ├── TEST-0.9.1.md │ │ ├── TEST-0.11.0.md │ │ ├── TEST-0.11.1.md │ │ ├── TEST-0.11.2.md │ │ ├── TEST-0.12.0.md │ │ ├── TEST-0.12.1.md │ │ ├── TEST-0.13.0.md │ │ ├── TEST-0.14.0.md │ │ ├── TEST-0.14.1.md │ │ ├── TEST-0.15.0.md │ │ ├── TEST-0.16.0.md │ │ ├── TEST-0.17.0.md │ │ ├── TEST-0.18.0.md │ │ ├── TEST-0.19.0.md │ │ ├── TEST-0.20.0.md │ │ └── TEST-latest.md │ │ └── default │ │ ├── main.tf │ │ ├── TEST-0.1.0.md │ │ ├── TEST-0.4.5.md │ │ ├── TEST-0.4.0.md │ │ └── TEST-0.5.0.md └── input │ └── basic │ └── main.tf ├── .yamllint ├── .editorconfig ├── LICENSE └── Dockerfiles ├── Dockerfile ├── Dockerfile-0.11 └── data ├── docker-entrypoint-0.12.sh ├── docker-entrypoint-0.11.sh └── terraform-docs.awk /.gitignore: -------------------------------------------------------------------------------- 1 | Makefile.docker 2 | Makefile.lint 3 | -------------------------------------------------------------------------------- /.github/FUNDING.yml: -------------------------------------------------------------------------------- 1 | --- 2 | github: [cytopia] 3 | -------------------------------------------------------------------------------- /tests/output/generate/0.12/main.tf: -------------------------------------------------------------------------------- 1 | ../../../input/0.12/main.tf -------------------------------------------------------------------------------- /tests/output/generate/basic/main.tf: -------------------------------------------------------------------------------- 1 | ../../../input/basic/main.tf -------------------------------------------------------------------------------- /tests/output/replace/0.12/main.tf: -------------------------------------------------------------------------------- 1 | ../../../input/0.12/main.tf -------------------------------------------------------------------------------- /tests/output/replace/basic/main.tf: -------------------------------------------------------------------------------- 1 | ../../../input/basic/main.tf -------------------------------------------------------------------------------- /tests/output/generate/default/main.tf: -------------------------------------------------------------------------------- 1 | ../../../input/default/main.tf -------------------------------------------------------------------------------- /tests/output/replace/default/main.tf: -------------------------------------------------------------------------------- 1 | ../../../input/default/main.tf -------------------------------------------------------------------------------- /tests/input/basic/main.tf: -------------------------------------------------------------------------------- 1 | variable "test" { 2 | description = "test description" 3 | } 4 | -------------------------------------------------------------------------------- /tests/output/generate/basic/TEST-0.1.0.md: -------------------------------------------------------------------------------- 1 | 2 | ## Inputs 3 | 4 | | Name | Description | Default | Required | 5 | |------|-------------|:-----:|:-----:| 6 | | test | test description | - | yes | 7 | 8 | -------------------------------------------------------------------------------- /.github/dependabot.yml: -------------------------------------------------------------------------------- 1 | --- 2 | version: 2 3 | updates: 4 | # Maintain dependencies for GitHub Actions 5 | - package-ecosystem: "github-actions" 6 | directory: "/" 7 | schedule: 8 | interval: "daily" 9 | -------------------------------------------------------------------------------- /tests/output/generate/basic/TEST-0.4.5.md: -------------------------------------------------------------------------------- 1 | ## Inputs 2 | 3 | | Name | Description | Type | Default | Required | 4 | |------|-------------|:----:|:-----:|:-----:| 5 | | test | test description | string | - | yes | 6 | 7 | -------------------------------------------------------------------------------- /tests/output/generate/basic/TEST-0.5.0.md: -------------------------------------------------------------------------------- 1 | ## Inputs 2 | 3 | | Name | Description | Type | Default | Required | 4 | |------|-------------|:----:|:-----:|:-----:| 5 | | test | test description | string | - | yes | 6 | 7 | -------------------------------------------------------------------------------- /tests/output/generate/basic/TEST-0.6.0.md: -------------------------------------------------------------------------------- 1 | ## Inputs 2 | 3 | | Name | Description | Type | Default | Required | 4 | |------|-------------|:----:|:-----:|:-----:| 5 | | test | test description | string | n/a | yes | 6 | 7 | -------------------------------------------------------------------------------- /tests/output/generate/basic/TEST-0.7.0.md: -------------------------------------------------------------------------------- 1 | ## Inputs 2 | 3 | | Name | Description | Type | Default | Required | 4 | |------|-------------|:----:|:-----:|:-----:| 5 | | test | test description | string | n/a | yes | 6 | 7 | -------------------------------------------------------------------------------- /tests/output/generate/basic/TEST-0.1.1.md: -------------------------------------------------------------------------------- 1 | 2 | ## Inputs 3 | 4 | | Name | Description | Type | Default | Required | 5 | |------|-------------|:----:|:-----:|:-----:| 6 | | test | test description | string | - | yes | 7 | 8 | -------------------------------------------------------------------------------- /tests/output/generate/basic/TEST-0.2.0.md: -------------------------------------------------------------------------------- 1 | 2 | ## Inputs 3 | 4 | | Name | Description | Type | Default | Required | 5 | |------|-------------|:----:|:-----:|:-----:| 6 | | test | test description | string | - | yes | 7 | 8 | -------------------------------------------------------------------------------- /tests/output/generate/basic/TEST-0.3.0.md: -------------------------------------------------------------------------------- 1 | 2 | ## Inputs 3 | 4 | | Name | Description | Type | Default | Required | 5 | |------|-------------|:----:|:-----:|:-----:| 6 | | test | test description | string | - | yes | 7 | 8 | -------------------------------------------------------------------------------- /tests/output/generate/basic/TEST-0.4.0.md: -------------------------------------------------------------------------------- 1 | 2 | ## Inputs 3 | 4 | | Name | Description | Type | Default | Required | 5 | |------|-------------|:----:|:-----:|:-----:| 6 | | test | test description | string | - | yes | 7 | 8 | -------------------------------------------------------------------------------- /.yamllint: -------------------------------------------------------------------------------- 1 | --- 2 | extends: default 3 | 4 | ignore: | 5 | /ansible/files/es-index-templates/logstash/ 6 | .terragrunt-cache/ 7 | .yamllint 8 | 9 | 10 | rules: 11 | truthy: 12 | allowed-values: ['true', 'false'] 13 | check-keys: False 14 | level: error 15 | line-length: disable 16 | -------------------------------------------------------------------------------- /tests/output/generate/basic/TEST-0.8.0.md: -------------------------------------------------------------------------------- 1 | ## Providers 2 | 3 | No provider. 4 | 5 | ## Inputs 6 | 7 | | Name | Description | Type | Default | Required | 8 | |------|-------------|------|---------|:-----:| 9 | | test | test description | `any` | n/a | yes | 10 | 11 | ## Outputs 12 | 13 | No output. 14 | 15 | -------------------------------------------------------------------------------- /tests/output/generate/basic/TEST-0.8.1.md: -------------------------------------------------------------------------------- 1 | ## Providers 2 | 3 | No provider. 4 | 5 | ## Inputs 6 | 7 | | Name | Description | Type | Default | Required | 8 | |------|-------------|------|---------|:-----:| 9 | | test | test description | `any` | n/a | yes | 10 | 11 | ## Outputs 12 | 13 | No output. 14 | 15 | -------------------------------------------------------------------------------- /tests/output/generate/basic/TEST-0.8.2.md: -------------------------------------------------------------------------------- 1 | ## Providers 2 | 3 | No provider. 4 | 5 | ## Inputs 6 | 7 | | Name | Description | Type | Default | Required | 8 | |------|-------------|------|---------|:-----:| 9 | | test | test description | `any` | n/a | yes | 10 | 11 | ## Outputs 12 | 13 | No output. 14 | 15 | -------------------------------------------------------------------------------- /tests/output/replace/basic/TEST-0.1.0.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | ## Inputs 4 | 5 | | Name | Description | Default | Required | 6 | |------|-------------|:-----:|:-----:| 7 | | test | test description | - | yes | 8 | 9 | 10 | -------------------------------------------------------------------------------- /tests/output/replace/basic/TEST-0.4.5.md: -------------------------------------------------------------------------------- 1 | 2 | ## Inputs 3 | 4 | | Name | Description | Type | Default | Required | 5 | |------|-------------|:----:|:-----:|:-----:| 6 | | test | test description | string | - | yes | 7 | 8 | 9 | -------------------------------------------------------------------------------- /tests/output/replace/basic/TEST-0.5.0.md: -------------------------------------------------------------------------------- 1 | 2 | ## Inputs 3 | 4 | | Name | Description | Type | Default | Required | 5 | |------|-------------|:----:|:-----:|:-----:| 6 | | test | test description | string | - | yes | 7 | 8 | 9 | -------------------------------------------------------------------------------- /tests/output/replace/basic/TEST-0.6.0.md: -------------------------------------------------------------------------------- 1 | 2 | ## Inputs 3 | 4 | | Name | Description | Type | Default | Required | 5 | |------|-------------|:----:|:-----:|:-----:| 6 | | test | test description | string | n/a | yes | 7 | 8 | 9 | -------------------------------------------------------------------------------- /tests/output/replace/basic/TEST-0.7.0.md: -------------------------------------------------------------------------------- 1 | 2 | ## Inputs 3 | 4 | | Name | Description | Type | Default | Required | 5 | |------|-------------|:----:|:-----:|:-----:| 6 | | test | test description | string | n/a | yes | 7 | 8 | 9 | -------------------------------------------------------------------------------- /tests/output/replace/basic/TEST-0.1.1.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | ## Inputs 4 | 5 | | Name | Description | Type | Default | Required | 6 | |------|-------------|:----:|:-----:|:-----:| 7 | | test | test description | string | - | yes | 8 | 9 | 10 | -------------------------------------------------------------------------------- /tests/output/replace/basic/TEST-0.2.0.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | ## Inputs 4 | 5 | | Name | Description | Type | Default | Required | 6 | |------|-------------|:----:|:-----:|:-----:| 7 | | test | test description | string | - | yes | 8 | 9 | 10 | -------------------------------------------------------------------------------- /tests/output/replace/basic/TEST-0.3.0.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | ## Inputs 4 | 5 | | Name | Description | Type | Default | Required | 6 | |------|-------------|:----:|:-----:|:-----:| 7 | | test | test description | string | - | yes | 8 | 9 | 10 | -------------------------------------------------------------------------------- /tests/output/replace/basic/TEST-0.4.0.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | ## Inputs 4 | 5 | | Name | Description | Type | Default | Required | 6 | |------|-------------|:----:|:-----:|:-----:| 7 | | test | test description | string | - | yes | 8 | 9 | 10 | -------------------------------------------------------------------------------- /tests/output/generate/basic/TEST-0.10.0.md: -------------------------------------------------------------------------------- 1 | ## Requirements 2 | 3 | No requirements. 4 | 5 | ## Providers 6 | 7 | No provider. 8 | 9 | ## Inputs 10 | 11 | | Name | Description | Type | Default | Required | 12 | |------|-------------|------|---------|:--------:| 13 | | test | test description | `any` | n/a | yes | 14 | 15 | ## Outputs 16 | 17 | No output. 18 | 19 | -------------------------------------------------------------------------------- /tests/output/generate/basic/TEST-0.10.1.md: -------------------------------------------------------------------------------- 1 | ## Requirements 2 | 3 | No requirements. 4 | 5 | ## Providers 6 | 7 | No provider. 8 | 9 | ## Inputs 10 | 11 | | Name | Description | Type | Default | Required | 12 | |------|-------------|------|---------|:--------:| 13 | | test | test description | `any` | n/a | yes | 14 | 15 | ## Outputs 16 | 17 | No output. 18 | 19 | -------------------------------------------------------------------------------- /tests/output/generate/basic/TEST-0.9.0.md: -------------------------------------------------------------------------------- 1 | ## Requirements 2 | 3 | No requirements. 4 | 5 | ## Providers 6 | 7 | No provider. 8 | 9 | ## Inputs 10 | 11 | | Name | Description | Type | Default | Required | 12 | |------|-------------|------|---------|:--------:| 13 | | test | test description | `any` | n/a | yes | 14 | 15 | ## Outputs 16 | 17 | No output. 18 | 19 | -------------------------------------------------------------------------------- /tests/output/generate/basic/TEST-0.9.1.md: -------------------------------------------------------------------------------- 1 | ## Requirements 2 | 3 | No requirements. 4 | 5 | ## Providers 6 | 7 | No provider. 8 | 9 | ## Inputs 10 | 11 | | Name | Description | Type | Default | Required | 12 | |------|-------------|------|---------|:--------:| 13 | | test | test description | `any` | n/a | yes | 14 | 15 | ## Outputs 16 | 17 | No output. 18 | 19 | -------------------------------------------------------------------------------- /tests/output/replace/basic/TEST-0.8.0.md: -------------------------------------------------------------------------------- 1 | 2 | ## Providers 3 | 4 | No provider. 5 | 6 | ## Inputs 7 | 8 | | Name | Description | Type | Default | Required | 9 | |------|-------------|------|---------|:-----:| 10 | | test | test description | `any` | n/a | yes | 11 | 12 | ## Outputs 13 | 14 | No output. 15 | 16 | 17 | -------------------------------------------------------------------------------- /tests/output/replace/basic/TEST-0.8.1.md: -------------------------------------------------------------------------------- 1 | 2 | ## Providers 3 | 4 | No provider. 5 | 6 | ## Inputs 7 | 8 | | Name | Description | Type | Default | Required | 9 | |------|-------------|------|---------|:-----:| 10 | | test | test description | `any` | n/a | yes | 11 | 12 | ## Outputs 13 | 14 | No output. 15 | 16 | 17 | -------------------------------------------------------------------------------- /tests/output/replace/basic/TEST-0.8.2.md: -------------------------------------------------------------------------------- 1 | 2 | ## Providers 3 | 4 | No provider. 5 | 6 | ## Inputs 7 | 8 | | Name | Description | Type | Default | Required | 9 | |------|-------------|------|---------|:-----:| 10 | | test | test description | `any` | n/a | yes | 11 | 12 | ## Outputs 13 | 14 | No output. 15 | 16 | 17 | -------------------------------------------------------------------------------- /.github/labels.yml: -------------------------------------------------------------------------------- 1 | # The labels in this file are automatically synced with the repository 2 | # using the micnncim/action-label-syncer action. 3 | --- 4 | - name: C-dependency 5 | color: 1abc9c 6 | description: "Category: Dependency" 7 | - name: PR-block 8 | color: 3498db 9 | description: "Pull Request: Do not merge" 10 | - name: PR-merge 11 | color: 3498db 12 | description: "Pull Request: Merge when ready" 13 | -------------------------------------------------------------------------------- /tests/output/generate/basic/TEST-0.11.0.md: -------------------------------------------------------------------------------- 1 | ## Requirements 2 | 3 | No requirements. 4 | 5 | ## Providers 6 | 7 | No provider. 8 | 9 | ## Modules 10 | 11 | No Modules. 12 | 13 | ## Resources 14 | 15 | No resources. 16 | 17 | ## Inputs 18 | 19 | | Name | Description | Type | Default | Required | 20 | |------|-------------|------|---------|:--------:| 21 | | test | test description | `any` | n/a | yes | 22 | 23 | ## Outputs 24 | 25 | No output. 26 | -------------------------------------------------------------------------------- /tests/output/generate/basic/TEST-0.11.1.md: -------------------------------------------------------------------------------- 1 | ## Requirements 2 | 3 | No requirements. 4 | 5 | ## Providers 6 | 7 | No provider. 8 | 9 | ## Modules 10 | 11 | No Modules. 12 | 13 | ## Resources 14 | 15 | No resources. 16 | 17 | ## Inputs 18 | 19 | | Name | Description | Type | Default | Required | 20 | |------|-------------|------|---------|:--------:| 21 | | test | test description | `any` | n/a | yes | 22 | 23 | ## Outputs 24 | 25 | No output. 26 | -------------------------------------------------------------------------------- /tests/output/generate/basic/TEST-0.11.2.md: -------------------------------------------------------------------------------- 1 | ## Requirements 2 | 3 | No requirements. 4 | 5 | ## Providers 6 | 7 | No provider. 8 | 9 | ## Modules 10 | 11 | No Modules. 12 | 13 | ## Resources 14 | 15 | No resources. 16 | 17 | ## Inputs 18 | 19 | | Name | Description | Type | Default | Required | 20 | |------|-------------|------|---------|:--------:| 21 | | test | test description | `any` | n/a | yes | 22 | 23 | ## Outputs 24 | 25 | No output. 26 | -------------------------------------------------------------------------------- /tests/output/replace/basic/TEST-0.10.0.md: -------------------------------------------------------------------------------- 1 | 2 | ## Requirements 3 | 4 | No requirements. 5 | 6 | ## Providers 7 | 8 | No provider. 9 | 10 | ## Inputs 11 | 12 | | Name | Description | Type | Default | Required | 13 | |------|-------------|------|---------|:--------:| 14 | | test | test description | `any` | n/a | yes | 15 | 16 | ## Outputs 17 | 18 | No output. 19 | 20 | 21 | -------------------------------------------------------------------------------- /tests/output/replace/basic/TEST-0.10.1.md: -------------------------------------------------------------------------------- 1 | 2 | ## Requirements 3 | 4 | No requirements. 5 | 6 | ## Providers 7 | 8 | No provider. 9 | 10 | ## Inputs 11 | 12 | | Name | Description | Type | Default | Required | 13 | |------|-------------|------|---------|:--------:| 14 | | test | test description | `any` | n/a | yes | 15 | 16 | ## Outputs 17 | 18 | No output. 19 | 20 | 21 | -------------------------------------------------------------------------------- /tests/output/replace/basic/TEST-0.9.0.md: -------------------------------------------------------------------------------- 1 | 2 | ## Requirements 3 | 4 | No requirements. 5 | 6 | ## Providers 7 | 8 | No provider. 9 | 10 | ## Inputs 11 | 12 | | Name | Description | Type | Default | Required | 13 | |------|-------------|------|---------|:--------:| 14 | | test | test description | `any` | n/a | yes | 15 | 16 | ## Outputs 17 | 18 | No output. 19 | 20 | 21 | -------------------------------------------------------------------------------- /tests/output/replace/basic/TEST-0.9.1.md: -------------------------------------------------------------------------------- 1 | 2 | ## Requirements 3 | 4 | No requirements. 5 | 6 | ## Providers 7 | 8 | No provider. 9 | 10 | ## Inputs 11 | 12 | | Name | Description | Type | Default | Required | 13 | |------|-------------|------|---------|:--------:| 14 | | test | test description | `any` | n/a | yes | 15 | 16 | ## Outputs 17 | 18 | No output. 19 | 20 | 21 | -------------------------------------------------------------------------------- /tests/output/generate/basic/TEST-0.12.0.md: -------------------------------------------------------------------------------- 1 | ## Requirements 2 | 3 | No requirements. 4 | 5 | ## Providers 6 | 7 | No providers. 8 | 9 | ## Modules 10 | 11 | No modules. 12 | 13 | ## Resources 14 | 15 | No resources. 16 | 17 | ## Inputs 18 | 19 | | Name | Description | Type | Default | Required | 20 | |------|-------------|------|---------|:--------:| 21 | | [test](#input\_test) | test description | `any` | n/a | yes | 22 | 23 | ## Outputs 24 | 25 | No outputs. 26 | -------------------------------------------------------------------------------- /tests/output/generate/basic/TEST-0.12.1.md: -------------------------------------------------------------------------------- 1 | ## Requirements 2 | 3 | No requirements. 4 | 5 | ## Providers 6 | 7 | No providers. 8 | 9 | ## Modules 10 | 11 | No modules. 12 | 13 | ## Resources 14 | 15 | No resources. 16 | 17 | ## Inputs 18 | 19 | | Name | Description | Type | Default | Required | 20 | |------|-------------|------|---------|:--------:| 21 | | [test](#input\_test) | test description | `any` | n/a | yes | 22 | 23 | ## Outputs 24 | 25 | No outputs. 26 | -------------------------------------------------------------------------------- /tests/output/generate/basic/TEST-0.13.0.md: -------------------------------------------------------------------------------- 1 | ## Requirements 2 | 3 | No requirements. 4 | 5 | ## Providers 6 | 7 | No providers. 8 | 9 | ## Modules 10 | 11 | No modules. 12 | 13 | ## Resources 14 | 15 | No resources. 16 | 17 | ## Inputs 18 | 19 | | Name | Description | Type | Default | Required | 20 | |------|-------------|------|---------|:--------:| 21 | | [test](#input\_test) | test description | `any` | n/a | yes | 22 | 23 | ## Outputs 24 | 25 | No outputs. 26 | -------------------------------------------------------------------------------- /tests/output/generate/basic/TEST-0.14.0.md: -------------------------------------------------------------------------------- 1 | ## Requirements 2 | 3 | No requirements. 4 | 5 | ## Providers 6 | 7 | No providers. 8 | 9 | ## Modules 10 | 11 | No modules. 12 | 13 | ## Resources 14 | 15 | No resources. 16 | 17 | ## Inputs 18 | 19 | | Name | Description | Type | Default | Required | 20 | |------|-------------|------|---------|:--------:| 21 | | [test](#input\_test) | test description | `any` | n/a | yes | 22 | 23 | ## Outputs 24 | 25 | No outputs. 26 | -------------------------------------------------------------------------------- /tests/output/generate/basic/TEST-0.14.1.md: -------------------------------------------------------------------------------- 1 | ## Requirements 2 | 3 | No requirements. 4 | 5 | ## Providers 6 | 7 | No providers. 8 | 9 | ## Modules 10 | 11 | No modules. 12 | 13 | ## Resources 14 | 15 | No resources. 16 | 17 | ## Inputs 18 | 19 | | Name | Description | Type | Default | Required | 20 | |------|-------------|------|---------|:--------:| 21 | | [test](#input\_test) | test description | `any` | n/a | yes | 22 | 23 | ## Outputs 24 | 25 | No outputs. 26 | -------------------------------------------------------------------------------- /tests/output/generate/basic/TEST-0.15.0.md: -------------------------------------------------------------------------------- 1 | ## Requirements 2 | 3 | No requirements. 4 | 5 | ## Providers 6 | 7 | No providers. 8 | 9 | ## Modules 10 | 11 | No modules. 12 | 13 | ## Resources 14 | 15 | No resources. 16 | 17 | ## Inputs 18 | 19 | | Name | Description | Type | Default | Required | 20 | |------|-------------|------|---------|:--------:| 21 | | [test](#input\_test) | test description | `any` | n/a | yes | 22 | 23 | ## Outputs 24 | 25 | No outputs. 26 | -------------------------------------------------------------------------------- /tests/output/generate/basic/TEST-0.16.0.md: -------------------------------------------------------------------------------- 1 | ## Requirements 2 | 3 | No requirements. 4 | 5 | ## Providers 6 | 7 | No providers. 8 | 9 | ## Modules 10 | 11 | No modules. 12 | 13 | ## Resources 14 | 15 | No resources. 16 | 17 | ## Inputs 18 | 19 | | Name | Description | Type | Default | Required | 20 | |------|-------------|------|---------|:--------:| 21 | | [test](#input\_test) | test description | `any` | n/a | yes | 22 | 23 | ## Outputs 24 | 25 | No outputs. 26 | -------------------------------------------------------------------------------- /tests/output/generate/basic/TEST-0.17.0.md: -------------------------------------------------------------------------------- 1 | ## Requirements 2 | 3 | No requirements. 4 | 5 | ## Providers 6 | 7 | No providers. 8 | 9 | ## Modules 10 | 11 | No modules. 12 | 13 | ## Resources 14 | 15 | No resources. 16 | 17 | ## Inputs 18 | 19 | | Name | Description | Type | Default | Required | 20 | |------|-------------|------|---------|:--------:| 21 | | [test](#input\_test) | test description | `any` | n/a | yes | 22 | 23 | ## Outputs 24 | 25 | No outputs. 26 | -------------------------------------------------------------------------------- /tests/output/generate/basic/TEST-0.18.0.md: -------------------------------------------------------------------------------- 1 | ## Requirements 2 | 3 | No requirements. 4 | 5 | ## Providers 6 | 7 | No providers. 8 | 9 | ## Modules 10 | 11 | No modules. 12 | 13 | ## Resources 14 | 15 | No resources. 16 | 17 | ## Inputs 18 | 19 | | Name | Description | Type | Default | Required | 20 | |------|-------------|------|---------|:--------:| 21 | | [test](#input\_test) | test description | `any` | n/a | yes | 22 | 23 | ## Outputs 24 | 25 | No outputs. 26 | -------------------------------------------------------------------------------- /tests/output/generate/basic/TEST-0.19.0.md: -------------------------------------------------------------------------------- 1 | ## Requirements 2 | 3 | No requirements. 4 | 5 | ## Providers 6 | 7 | No providers. 8 | 9 | ## Modules 10 | 11 | No modules. 12 | 13 | ## Resources 14 | 15 | No resources. 16 | 17 | ## Inputs 18 | 19 | | Name | Description | Type | Default | Required | 20 | |------|-------------|------|---------|:--------:| 21 | | [test](#input\_test) | test description | `any` | n/a | yes | 22 | 23 | ## Outputs 24 | 25 | No outputs. 26 | -------------------------------------------------------------------------------- /tests/output/generate/basic/TEST-0.20.0.md: -------------------------------------------------------------------------------- 1 | ## Requirements 2 | 3 | No requirements. 4 | 5 | ## Providers 6 | 7 | No providers. 8 | 9 | ## Modules 10 | 11 | No modules. 12 | 13 | ## Resources 14 | 15 | No resources. 16 | 17 | ## Inputs 18 | 19 | | Name | Description | Type | Default | Required | 20 | |------|-------------|------|---------|:--------:| 21 | | [test](#input\_test) | test description | `any` | n/a | yes | 22 | 23 | ## Outputs 24 | 25 | No outputs. 26 | -------------------------------------------------------------------------------- /tests/output/generate/basic/TEST-latest.md: -------------------------------------------------------------------------------- 1 | ## Requirements 2 | 3 | No requirements. 4 | 5 | ## Providers 6 | 7 | No providers. 8 | 9 | ## Modules 10 | 11 | No modules. 12 | 13 | ## Resources 14 | 15 | No resources. 16 | 17 | ## Inputs 18 | 19 | | Name | Description | Type | Default | Required | 20 | |------|-------------|------|---------|:--------:| 21 | | [test](#input\_test) | test description | `any` | n/a | yes | 22 | 23 | ## Outputs 24 | 25 | No outputs. 26 | -------------------------------------------------------------------------------- /.github/workflows/release-drafter.yml: -------------------------------------------------------------------------------- 1 | --- 2 | name: Release Drafter 3 | 4 | on: 5 | push: 6 | # branches to consider in the event; optional, defaults to all 7 | branches: 8 | - master 9 | 10 | jobs: 11 | update_release_draft: 12 | runs-on: ubuntu-latest 13 | steps: 14 | # Drafts your next Release notes as Pull Requests are merged into "master" 15 | - uses: release-drafter/release-drafter@v5 16 | with: 17 | publish: true 18 | env: 19 | GITHUB_TOKEN: ${{ secrets.RELEASE_DRAFTER_TOKEN }} 20 | -------------------------------------------------------------------------------- /.github/workflows/repository.yml: -------------------------------------------------------------------------------- 1 | --- 2 | name: Repository 3 | 4 | on: 5 | push: 6 | branches: 7 | - master 8 | paths: 9 | - .github/labels.yml 10 | 11 | jobs: 12 | labels: 13 | name: Labels 14 | runs-on: ubuntu-latest 15 | 16 | steps: 17 | - name: Checkout code 18 | uses: actions/checkout@v4 19 | 20 | - name: Sync labels 21 | uses: micnncim/action-label-syncer@v1 22 | env: 23 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 24 | with: 25 | manifest: .github/labels.yml 26 | -------------------------------------------------------------------------------- /tests/output/replace/basic/TEST-0.11.0.md: -------------------------------------------------------------------------------- 1 | 2 | ## Requirements 3 | 4 | No requirements. 5 | 6 | ## Providers 7 | 8 | No provider. 9 | 10 | ## Modules 11 | 12 | No Modules. 13 | 14 | ## Resources 15 | 16 | No resources. 17 | 18 | ## Inputs 19 | 20 | | Name | Description | Type | Default | Required | 21 | |------|-------------|------|---------|:--------:| 22 | | test | test description | `any` | n/a | yes | 23 | 24 | ## Outputs 25 | 26 | No output. 27 | 28 | 29 | -------------------------------------------------------------------------------- /tests/output/replace/basic/TEST-0.11.1.md: -------------------------------------------------------------------------------- 1 | 2 | ## Requirements 3 | 4 | No requirements. 5 | 6 | ## Providers 7 | 8 | No provider. 9 | 10 | ## Modules 11 | 12 | No Modules. 13 | 14 | ## Resources 15 | 16 | No resources. 17 | 18 | ## Inputs 19 | 20 | | Name | Description | Type | Default | Required | 21 | |------|-------------|------|---------|:--------:| 22 | | test | test description | `any` | n/a | yes | 23 | 24 | ## Outputs 25 | 26 | No output. 27 | 28 | 29 | -------------------------------------------------------------------------------- /tests/output/replace/basic/TEST-0.11.2.md: -------------------------------------------------------------------------------- 1 | 2 | ## Requirements 3 | 4 | No requirements. 5 | 6 | ## Providers 7 | 8 | No provider. 9 | 10 | ## Modules 11 | 12 | No Modules. 13 | 14 | ## Resources 15 | 16 | No resources. 17 | 18 | ## Inputs 19 | 20 | | Name | Description | Type | Default | Required | 21 | |------|-------------|------|---------|:--------:| 22 | | test | test description | `any` | n/a | yes | 23 | 24 | ## Outputs 25 | 26 | No output. 27 | 28 | 29 | -------------------------------------------------------------------------------- /tests/output/replace/basic/TEST-0.12.0.md: -------------------------------------------------------------------------------- 1 | 2 | ## Requirements 3 | 4 | No requirements. 5 | 6 | ## Providers 7 | 8 | No providers. 9 | 10 | ## Modules 11 | 12 | No modules. 13 | 14 | ## Resources 15 | 16 | No resources. 17 | 18 | ## Inputs 19 | 20 | | Name | Description | Type | Default | Required | 21 | |------|-------------|------|---------|:--------:| 22 | | [test](#input\_test) | test description | `any` | n/a | yes | 23 | 24 | ## Outputs 25 | 26 | No outputs. 27 | 28 | 29 | -------------------------------------------------------------------------------- /tests/output/replace/basic/TEST-0.12.1.md: -------------------------------------------------------------------------------- 1 | 2 | ## Requirements 3 | 4 | No requirements. 5 | 6 | ## Providers 7 | 8 | No providers. 9 | 10 | ## Modules 11 | 12 | No modules. 13 | 14 | ## Resources 15 | 16 | No resources. 17 | 18 | ## Inputs 19 | 20 | | Name | Description | Type | Default | Required | 21 | |------|-------------|------|---------|:--------:| 22 | | [test](#input\_test) | test description | `any` | n/a | yes | 23 | 24 | ## Outputs 25 | 26 | No outputs. 27 | 28 | 29 | -------------------------------------------------------------------------------- /tests/output/replace/basic/TEST-0.13.0.md: -------------------------------------------------------------------------------- 1 | 2 | ## Requirements 3 | 4 | No requirements. 5 | 6 | ## Providers 7 | 8 | No providers. 9 | 10 | ## Modules 11 | 12 | No modules. 13 | 14 | ## Resources 15 | 16 | No resources. 17 | 18 | ## Inputs 19 | 20 | | Name | Description | Type | Default | Required | 21 | |------|-------------|------|---------|:--------:| 22 | | [test](#input\_test) | test description | `any` | n/a | yes | 23 | 24 | ## Outputs 25 | 26 | No outputs. 27 | 28 | 29 | -------------------------------------------------------------------------------- /tests/output/replace/basic/TEST-0.14.0.md: -------------------------------------------------------------------------------- 1 | 2 | ## Requirements 3 | 4 | No requirements. 5 | 6 | ## Providers 7 | 8 | No providers. 9 | 10 | ## Modules 11 | 12 | No modules. 13 | 14 | ## Resources 15 | 16 | No resources. 17 | 18 | ## Inputs 19 | 20 | | Name | Description | Type | Default | Required | 21 | |------|-------------|------|---------|:--------:| 22 | | [test](#input\_test) | test description | `any` | n/a | yes | 23 | 24 | ## Outputs 25 | 26 | No outputs. 27 | 28 | 29 | -------------------------------------------------------------------------------- /tests/output/replace/basic/TEST-0.14.1.md: -------------------------------------------------------------------------------- 1 | 2 | ## Requirements 3 | 4 | No requirements. 5 | 6 | ## Providers 7 | 8 | No providers. 9 | 10 | ## Modules 11 | 12 | No modules. 13 | 14 | ## Resources 15 | 16 | No resources. 17 | 18 | ## Inputs 19 | 20 | | Name | Description | Type | Default | Required | 21 | |------|-------------|------|---------|:--------:| 22 | | [test](#input\_test) | test description | `any` | n/a | yes | 23 | 24 | ## Outputs 25 | 26 | No outputs. 27 | 28 | 29 | -------------------------------------------------------------------------------- /tests/output/replace/basic/TEST-0.15.0.md: -------------------------------------------------------------------------------- 1 | 2 | ## Requirements 3 | 4 | No requirements. 5 | 6 | ## Providers 7 | 8 | No providers. 9 | 10 | ## Modules 11 | 12 | No modules. 13 | 14 | ## Resources 15 | 16 | No resources. 17 | 18 | ## Inputs 19 | 20 | | Name | Description | Type | Default | Required | 21 | |------|-------------|------|---------|:--------:| 22 | | [test](#input\_test) | test description | `any` | n/a | yes | 23 | 24 | ## Outputs 25 | 26 | No outputs. 27 | 28 | 29 | -------------------------------------------------------------------------------- /tests/output/replace/basic/TEST-0.16.0.md: -------------------------------------------------------------------------------- 1 | 2 | ## Requirements 3 | 4 | No requirements. 5 | 6 | ## Providers 7 | 8 | No providers. 9 | 10 | ## Modules 11 | 12 | No modules. 13 | 14 | ## Resources 15 | 16 | No resources. 17 | 18 | ## Inputs 19 | 20 | | Name | Description | Type | Default | Required | 21 | |------|-------------|------|---------|:--------:| 22 | | [test](#input\_test) | test description | `any` | n/a | yes | 23 | 24 | ## Outputs 25 | 26 | No outputs. 27 | 28 | 29 | -------------------------------------------------------------------------------- /tests/output/replace/basic/TEST-0.17.0.md: -------------------------------------------------------------------------------- 1 | 2 | ## Requirements 3 | 4 | No requirements. 5 | 6 | ## Providers 7 | 8 | No providers. 9 | 10 | ## Modules 11 | 12 | No modules. 13 | 14 | ## Resources 15 | 16 | No resources. 17 | 18 | ## Inputs 19 | 20 | | Name | Description | Type | Default | Required | 21 | |------|-------------|------|---------|:--------:| 22 | | [test](#input\_test) | test description | `any` | n/a | yes | 23 | 24 | ## Outputs 25 | 26 | No outputs. 27 | 28 | 29 | -------------------------------------------------------------------------------- /tests/output/replace/basic/TEST-0.18.0.md: -------------------------------------------------------------------------------- 1 | 2 | ## Requirements 3 | 4 | No requirements. 5 | 6 | ## Providers 7 | 8 | No providers. 9 | 10 | ## Modules 11 | 12 | No modules. 13 | 14 | ## Resources 15 | 16 | No resources. 17 | 18 | ## Inputs 19 | 20 | | Name | Description | Type | Default | Required | 21 | |------|-------------|------|---------|:--------:| 22 | | [test](#input\_test) | test description | `any` | n/a | yes | 23 | 24 | ## Outputs 25 | 26 | No outputs. 27 | 28 | 29 | -------------------------------------------------------------------------------- /tests/output/replace/basic/TEST-0.19.0.md: -------------------------------------------------------------------------------- 1 | 2 | ## Requirements 3 | 4 | No requirements. 5 | 6 | ## Providers 7 | 8 | No providers. 9 | 10 | ## Modules 11 | 12 | No modules. 13 | 14 | ## Resources 15 | 16 | No resources. 17 | 18 | ## Inputs 19 | 20 | | Name | Description | Type | Default | Required | 21 | |------|-------------|------|---------|:--------:| 22 | | [test](#input\_test) | test description | `any` | n/a | yes | 23 | 24 | ## Outputs 25 | 26 | No outputs. 27 | 28 | 29 | -------------------------------------------------------------------------------- /tests/output/replace/basic/TEST-0.20.0.md: -------------------------------------------------------------------------------- 1 | 2 | ## Requirements 3 | 4 | No requirements. 5 | 6 | ## Providers 7 | 8 | No providers. 9 | 10 | ## Modules 11 | 12 | No modules. 13 | 14 | ## Resources 15 | 16 | No resources. 17 | 18 | ## Inputs 19 | 20 | | Name | Description | Type | Default | Required | 21 | |------|-------------|------|---------|:--------:| 22 | | [test](#input\_test) | test description | `any` | n/a | yes | 23 | 24 | ## Outputs 25 | 26 | No outputs. 27 | 28 | 29 | -------------------------------------------------------------------------------- /tests/output/replace/basic/TEST-latest.md: -------------------------------------------------------------------------------- 1 | 2 | ## Requirements 3 | 4 | No requirements. 5 | 6 | ## Providers 7 | 8 | No providers. 9 | 10 | ## Modules 11 | 12 | No modules. 13 | 14 | ## Resources 15 | 16 | No resources. 17 | 18 | ## Inputs 19 | 20 | | Name | Description | Type | Default | Required | 21 | |------|-------------|------|---------|:--------:| 22 | | [test](#input\_test) | test description | `any` | n/a | yes | 23 | 24 | ## Outputs 25 | 26 | No outputs. 27 | 28 | 29 | -------------------------------------------------------------------------------- /.editorconfig: -------------------------------------------------------------------------------- 1 | # EditorConfig is awesome: http://EditorConfig.org 2 | # Uses editorconfig to maintain consistent coding styles 3 | 4 | # top-most EditorConfig file 5 | root = true 6 | 7 | # Unix-style newlines with a newline ending every file 8 | [*] 9 | charset = utf-8 10 | end_of_line = lf 11 | indent_size = 2 12 | indent_style = space 13 | insert_final_newline = true 14 | max_line_length = 120 15 | trim_trailing_whitespace = true 16 | 17 | [*.{tf,tfvars}] 18 | indent_size = 2 19 | indent_style = space 20 | 21 | [*.py] 22 | indent_size = 4 23 | 24 | [*.md] 25 | max_line_length = 0 26 | trim_trailing_whitespace = false 27 | 28 | [*.sh] 29 | indent_size = 4 30 | indent_style = tab 31 | 32 | [Makefile] 33 | indent_size = 4 34 | indent_style = tab 35 | -------------------------------------------------------------------------------- /.github/release-drafter.yml: -------------------------------------------------------------------------------- 1 | --- 2 | name-template: '$RESOLVED_VERSION 🌈' 3 | tag-template: '$RESOLVED_VERSION' 4 | version-template: '$MAJOR.$MINOR' 5 | categories: 6 | - title: '🚀 Features' 7 | labels: 8 | - 'feature' 9 | - 'enhancement' 10 | - title: '🐛 Bug Fixes' 11 | labels: 12 | - 'fix' 13 | - 'bugfix' 14 | - 'bug' 15 | - title: '🧰 Maintenance' 16 | label: 'chore' 17 | change-template: '- $TITLE @$AUTHOR (#$NUMBER)' 18 | change-title-escapes: '\<*_&' # You can add # and @ to disable mentions, and add ` to disable code blocks. 19 | version-resolver: 20 | major: 21 | labels: 22 | - 'major' 23 | minor: 24 | labels: 25 | - 'minor' 26 | patch: 27 | labels: 28 | - 'patch' 29 | default: minor 30 | template: | 31 | ## Changes 32 | 33 | $CHANGES 34 | -------------------------------------------------------------------------------- /.github/workflows/lint.yml: -------------------------------------------------------------------------------- 1 | --- 2 | 3 | # ------------------------------------------------------------------------------------------------- 4 | # Job Name 5 | # ------------------------------------------------------------------------------------------------- 6 | name: lint 7 | 8 | 9 | # ------------------------------------------------------------------------------------------------- 10 | # When to run 11 | # ------------------------------------------------------------------------------------------------- 12 | on: 13 | # Runs on Pull Requests 14 | pull_request: 15 | 16 | 17 | # ------------------------------------------------------------------------------------------------- 18 | # What to run 19 | # ------------------------------------------------------------------------------------------------- 20 | jobs: 21 | lint: 22 | uses: devilbox/github-actions/.github/workflows/lint-generic.yml@master 23 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2019 cytopia 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /.github/workflows/action_pull_request.yml: -------------------------------------------------------------------------------- 1 | --- 2 | 3 | # ------------------------------------------------------------------------------------------------- 4 | # Job Name 5 | # ------------------------------------------------------------------------------------------------- 6 | name: build 7 | 8 | 9 | # ------------------------------------------------------------------------------------------------- 10 | # When to run 11 | # ------------------------------------------------------------------------------------------------- 12 | on: 13 | pull_request: 14 | 15 | 16 | jobs: 17 | 18 | # (1/2) Determine repository params 19 | params: 20 | uses: ./.github/workflows/params.yml 21 | # Only run for forks (contributor) 22 | if: github.event.pull_request.head.repo.fork 23 | 24 | # (2/2) Build 25 | docker: 26 | needs: [params] 27 | uses: devilbox/github-actions/.github/workflows/docker-name-version-flavour-arch.yml@master 28 | with: 29 | enabled: true 30 | can_deploy: false 31 | matrix: ${{ needs.params.outputs.matrix }} 32 | refs: ${{ needs.params.outputs.refs }} 33 | secrets: 34 | dockerhub_username: "" 35 | dockerhub_password: "" 36 | -------------------------------------------------------------------------------- /.github/workflows/action_schedule.yml: -------------------------------------------------------------------------------- 1 | --- 2 | 3 | # ------------------------------------------------------------------------------------------------- 4 | # Job Name 5 | # ------------------------------------------------------------------------------------------------- 6 | name: nightly 7 | 8 | 9 | # ------------------------------------------------------------------------------------------------- 10 | # When to run 11 | # ------------------------------------------------------------------------------------------------- 12 | on: 13 | # Runs daily 14 | schedule: 15 | - cron: '0 0 * * *' 16 | 17 | 18 | jobs: 19 | 20 | # (1/2) Determine repository params 21 | params: 22 | uses: ./.github/workflows/params.yml 23 | 24 | # (2/2) Build 25 | docker: 26 | needs: [params] 27 | uses: devilbox/github-actions/.github/workflows/docker-name-version-flavour-arch.yml@master 28 | with: 29 | enabled: true 30 | can_deploy: true 31 | matrix: ${{ needs.params.outputs.matrix }} 32 | refs: ${{ needs.params.outputs.refs }} 33 | secrets: 34 | dockerhub_username: ${{ secrets.DOCKERHUB_USERNAME }} 35 | dockerhub_password: ${{ secrets.DOCKERHUB_PASSWORD }} 36 | -------------------------------------------------------------------------------- /.github/workflows/action_branch.yml: -------------------------------------------------------------------------------- 1 | --- 2 | 3 | # ------------------------------------------------------------------------------------------------- 4 | # Job Name 5 | # ------------------------------------------------------------------------------------------------- 6 | name: build 7 | 8 | 9 | # ------------------------------------------------------------------------------------------------- 10 | # When to run 11 | # ------------------------------------------------------------------------------------------------- 12 | on: 13 | push: 14 | paths: 15 | - 'Makefile' 16 | - 'Dockerfiles/**' 17 | - 'tests/**' 18 | - '.github/workflows/action*.yml' 19 | - '.github/workflows/params.yml' 20 | 21 | jobs: 22 | 23 | # (1/2) Determine repository params 24 | params: 25 | uses: ./.github/workflows/params.yml 26 | 27 | # (2/2) Build 28 | docker: 29 | needs: [params] 30 | uses: devilbox/github-actions/.github/workflows/docker-name-version-flavour-arch.yml@master 31 | with: 32 | enabled: true 33 | can_deploy: ${{ github.ref == 'refs/heads/master' || startsWith(github.ref, 'refs/tags/') || startsWith(github.ref, 'refs/heads/release-') }} 34 | matrix: ${{ needs.params.outputs.matrix }} 35 | refs: ${{ needs.params.outputs.refs }} 36 | secrets: 37 | dockerhub_username: ${{ secrets.DOCKERHUB_USERNAME }} 38 | dockerhub_password: ${{ secrets.DOCKERHUB_PASSWORD }} 39 | -------------------------------------------------------------------------------- /Dockerfiles/Dockerfile: -------------------------------------------------------------------------------- 1 | FROM golang:1.24.4-alpine as builder 2 | 3 | # Install dependencies 4 | RUN set -x \ 5 | && apk add --update --no-cache \ 6 | bash \ 7 | ca-certificates \ 8 | curl \ 9 | dpkg \ 10 | gcc \ 11 | git \ 12 | make \ 13 | musl-dev \ 14 | openssh \ 15 | wget 16 | 17 | # Get and build terraform-docs 18 | ARG VERSION=latest 19 | RUN set -x \ 20 | && mkdir -p /go/src/github.com \ 21 | && git clone https://github.com/terraform-docs/terraform-docs /go/src/github.com/terraform-docs \ 22 | && cd /go/src/github.com/terraform-docs \ 23 | \ 24 | # Check out specific tag 25 | && if [ "${VERSION}" != "latest" ]; then \ 26 | git checkout v${VERSION}; \ 27 | fi \ 28 | \ 29 | # Build 30 | && go mod download \ 31 | && make build 32 | 33 | RUN set -x \ 34 | && dpkg --print-architecture \ 35 | \ 36 | # Copy correct architecture 37 | && if [ "$(dpkg --print-architecture | awk -F'-' '{print $NF}' )" = "i386" ]; then\ 38 | mv /go/src/github.com/terraform-docs/bin/linux-386/terraform-docs /usr/local/bin/terraform-docs; \ 39 | elif [ "$(uname -m)" = "x86_64" ]; then \ 40 | mv /go/src/github.com/terraform-docs/bin/linux-amd64/terraform-docs /usr/local/bin/terraform-docs; \ 41 | elif [ "$(uname -m)" = "aarch64" ]; then \ 42 | mv /go/src/github.com/terraform-docs/bin/linux-arm64/terraform-docs /usr/local/bin/terraform-docs; \ 43 | elif [ "$(uname -m)" = "armv7l" ]; then \ 44 | mv /go/src/github.com/terraform-docs/bin/linux-arm/terraform-docs /usr/local/bin/terraform-docs; \ 45 | else \ 46 | mv /go/src/github.com/terraform-docs/bin/linux-$(uname -m)/terraform-docs /usr/local/bin/terraform-docs; \ 47 | fi 48 | 49 | # Version pre-check 50 | RUN set -x \ 51 | && if [ "${VERSION}" != "latest" ]; then \ 52 | terraform-docs --version | grep "${VERSION}"; \ 53 | else \ 54 | terraform-docs --version | grep -E "(terraform-docs[[:space:]])?(version[[:space:]])?(v?[.0-9]+)?-?(dev|latest|beta)?"; \ 55 | fi 56 | 57 | 58 | # Use a clean tiny image to store artifacts in 59 | FROM alpine:3.11 60 | LABEL \ 61 | maintainer="cytopia " \ 62 | repo="https://github.com/cytopia/docker-terraform-docs" 63 | COPY --from=builder /usr/local/bin/terraform-docs /usr/local/bin/terraform-docs 64 | COPY ./data/docker-entrypoint-0.12.sh /docker-entrypoint.sh 65 | 66 | WORKDIR /data 67 | 68 | CMD ["terraform-docs", "--version"] 69 | ENTRYPOINT ["/docker-entrypoint.sh"] 70 | -------------------------------------------------------------------------------- /Dockerfiles/Dockerfile-0.11: -------------------------------------------------------------------------------- 1 | FROM golang:alpine3.9 as builder 2 | 3 | # Install dependencies 4 | RUN set -x \ 5 | && apk add --no-cache \ 6 | bash \ 7 | curl \ 8 | gcc \ 9 | git \ 10 | make \ 11 | musl-dev \ 12 | && curl https://raw.githubusercontent.com/golang/dep/master/install.sh | sh 13 | 14 | # Get and build terraform-docs 15 | ARG VERSION=latest 16 | RUN set -x \ 17 | && export GOPATH=/go \ 18 | && mkdir -p /go/src/github.com/terraform-docs \ 19 | && git clone https://github.com/terraform-docs/terraform-docs /go/src/github.com/segmentio/terraform-docs \ 20 | && cd /go/src/github.com/segmentio/terraform-docs \ 21 | && if [ "${VERSION}" != "latest" ]; then \ 22 | git checkout v${VERSION}; \ 23 | fi \ 24 | # Build terraform-docs <= 0.3.0 25 | && if [ "${VERSION}" = "0.3.0" ] || [ "${VERSION}" = "0.2.0" ] || [ "${VERSION}" = "0.1.1" ] || [ "${VERSION}" = "0.1.0" ]; then \ 26 | go get github.com/hashicorp/hcl \ 27 | && go get github.com/mitchellh/gox \ 28 | && go get github.com/tj/docopt \ 29 | && sed -i'' 's/darwin//g' Makefile \ 30 | && sed -i'' 's/windows//g' Makefile \ 31 | && make \ 32 | && mv dist/terraform-docs_linux_amd64 /usr/local/bin/terraform-docs; \ 33 | # Build terraform-docs 0.7.0 34 | elif [ "${VERSION}" = "0.7.0" ]; then \ 35 | make test \ 36 | && make gox build-all GOOS=linux GOARCH=amd64 \ 37 | && mv bin/terraform-docs-${VERSION}-linux-amd64 /usr/local/bin/terraform-docs; \ 38 | # Build terraform-docs > 0.3.0 39 | else \ 40 | make deps \ 41 | && make test \ 42 | && make build-linux-amd64 \ 43 | && if [ "${VERSION}" = "0.4.0" ]; then \ 44 | mv bin/terraform-docs-v${VERSION}-linux-amd64 /usr/local/bin/terraform-docs; \ 45 | else \ 46 | mv bin/linux-amd64/terraform-docs /usr/local/bin/terraform-docs; \ 47 | fi \ 48 | fi \ 49 | && chmod +x /usr/local/bin/terraform-docs 50 | 51 | # Version pre-check 52 | RUN set -x \ 53 | && if [ "${VERSION}" != "latest" ]; then \ 54 | terraform-docs --version | grep "${VERSION}"; \ 55 | else \ 56 | terraform-docs --version | grep -E "(terraform-docs[[:space:]])?(version[[:space:]])?(dev|latest)"; \ 57 | fi 58 | 59 | 60 | # Use a clean tiny image to store artifacts in 61 | FROM alpine:3.8 62 | LABEL \ 63 | maintainer="cytopia " \ 64 | repo="https://github.com/cytopia/docker-terraform-docs" 65 | COPY --from=builder /usr/local/bin/terraform-docs /usr/local/bin/terraform-docs 66 | COPY ./data/docker-entrypoint-0.11.sh /docker-entrypoint.sh 67 | COPY ./data/terraform-docs.awk /terraform-docs.awk 68 | 69 | WORKDIR /data 70 | 71 | CMD ["terraform-docs", "--version"] 72 | ENTRYPOINT ["/docker-entrypoint.sh"] 73 | -------------------------------------------------------------------------------- /.github/workflows/params.yml: -------------------------------------------------------------------------------- 1 | --- 2 | 3 | # ------------------------------------------------------------------------------------------------- 4 | # Job Name 5 | # ------------------------------------------------------------------------------------------------- 6 | name: params 7 | 8 | 9 | # ------------------------------------------------------------------------------------------------- 10 | # Custom Variables 11 | # ------------------------------------------------------------------------------------------------- 12 | env: 13 | MATRIX: >- 14 | [ 15 | { 16 | "NAME": "tfdocs", 17 | "VERSION": [ 18 | "latest", 19 | "0.20.0", 20 | "0.19.0", 21 | "0.18.0", 22 | "0.17.0", 23 | "0.16.0", 24 | "0.15.0", 25 | "0.14.1", 26 | "0.14.0", 27 | "0.13.0", 28 | "0.12.1", 29 | "0.12.0" 30 | ], 31 | "FLAVOUR": ["latest"], 32 | "ARCH": ["linux/amd64", "linux/386", "linux/arm64", "linux/arm/v7", "linux/arm/v6"] 33 | }, 34 | { 35 | "NAME": "tfdocs", 36 | "VERSION": [ 37 | "0.11.2", 38 | "0.11.1", 39 | "0.11.0", 40 | "0.10.1", 41 | "0.10.0", 42 | "0.9.1", 43 | "0.9.0", 44 | "0.8.2", 45 | "0.8.1", 46 | "0.8.0", 47 | "0.7.0", 48 | "0.6.0", 49 | "0.5.0", 50 | "0.4.5", 51 | "0.4.0" 52 | ], 53 | "FLAVOUR": ["latest"], 54 | "ARCH": ["linux/amd64"] 55 | } 56 | ] 57 | 58 | 59 | # ------------------------------------------------------------------------------------------------- 60 | # When to run 61 | # ------------------------------------------------------------------------------------------------- 62 | on: 63 | workflow_call: 64 | outputs: 65 | matrix: 66 | description: "The determined version matrix" 67 | value: ${{ jobs.params.outputs.matrix }} 68 | refs: 69 | description: "The determined git ref matrix (only during scheduled run)" 70 | value: ${{ jobs.params.outputs.refs }} 71 | 72 | jobs: 73 | params: 74 | runs-on: ubuntu-latest 75 | 76 | outputs: 77 | matrix: ${{ steps.set-matrix.outputs.matrix }} 78 | refs: ${{ steps.set-refs.outputs.matrix }} 79 | 80 | steps: 81 | - name: "[Set-Output] Matrix" 82 | id: set-matrix 83 | run: | 84 | echo "matrix=$( echo '${{ env.MATRIX }}' | jq -M -c )" >> $GITHUB_OUTPUT 85 | 86 | - name: "[Set-Output] Matrix 'Refs' (master branch and latest tag)" 87 | id: set-refs 88 | uses: cytopia/git-ref-matrix-action@v0.1.13 89 | with: 90 | repository_default_branch: master 91 | branches: master 92 | num_latest_tags: 0 93 | if: github.event_name == 'schedule' 94 | 95 | - name: "[DEBUG] Show settings'" 96 | run: | 97 | echo 'Matrix' 98 | echo '--------------------' 99 | echo '${{ steps.set-matrix.outputs.matrix }}' 100 | echo 101 | 102 | echo 'Matrix: Refs' 103 | echo '--------------------' 104 | echo '${{ steps.set-matrix-refs.outputs.matrix }}' 105 | echo 106 | -------------------------------------------------------------------------------- /Dockerfiles/data/docker-entrypoint-0.12.sh: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | set -e 4 | set -u 5 | 6 | 7 | ### 8 | ### Default variables 9 | ### 10 | DEF_DELIM_START='' 11 | DEF_DELIM_CLOSE='' 12 | 13 | 14 | ### 15 | ### Environment variables 16 | ### 17 | 18 | # Set delimiter 19 | if ! env | grep -q '^DELIM_START='; then 20 | DELIM_START="${DEF_DELIM_START}" 21 | fi 22 | if ! env | grep -q '^DELIM_CLOSE='; then 23 | DELIM_CLOSE="${DEF_DELIM_CLOSE}" 24 | fi 25 | 26 | 27 | ### 28 | ### Helper functions 29 | ### 30 | 31 | # Returns all but the last argument as an array using a POSIX-compliant method 32 | # for handling arrays. 33 | # Credit: https://gist.github.com/akutz/7a39159bbbe9c299c79f1d2107ef1357 34 | trim_last_arg() { 35 | _l="${#}" _i=0 _j="$((_l-1))" && while [ "${_i}" -lt "${_l}" ]; do 36 | if [ "${_i}" -lt "${_j}" ]; then 37 | printf '%s\n' "${1}" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" 38 | fi 39 | shift; _i="$((_i+1))" 40 | done 41 | echo " " 42 | } 43 | 44 | 45 | print_usage() { 46 | >&2 echo "Error, Unsupported command." 47 | >&2 echo "Usage: cytopia/terraform-docs terraform-docs ." 48 | >&2 echo " cytopia/terraform-docs terraform-docs-012 ." 49 | >&2 echo 50 | >&2 echo " cytopia/terraform-docs terraform-docs-replace " 51 | >&2 echo " cytopia/terraform-docs terraform-docs-replace-012 " 52 | >&2 echo 53 | >&2 echo 54 | >&2 echo "terraform-docs Output as expected from terraform-docs" 55 | >&2 echo "terraform-docs-012 Same as above, but used for Terraform >= 0.12 modules" 56 | >&2 echo " (Not required anymore and will become deprecated)" 57 | >&2 echo 58 | >&2 echo "terraform-docs-replace Replaces directly inside README.md, if DELIM_START and DELIM_CLOSE are found." 59 | >&2 echo "terraform-docs-replace-012 Same as above, but used for Terraform >= 0.12 modules" 60 | >&2 echo " (Not required anymore and will become deprecated)" 61 | >&2 echo 62 | >&2 echo " All arguments terraform-docs command can use." 63 | >&2 echo " File in where to auto-replace terraform-docs block." 64 | } 65 | 66 | 67 | ### 68 | ### Arguments appended? 69 | ### 70 | if [ "${#}" -ge "1" ]; then 71 | 72 | ### 73 | ### Custom replace operation 74 | ### 75 | if [ "${1}" = "terraform-docs-replace" ] || [ "${1}" = "terraform-docs-replace-012" ]; then 76 | 77 | # Store and Remove last argument (filename) 78 | eval MY_FILE="\${$#}" # store last argument 79 | args="$(trim_last_arg "${@}")" # get all the args except the last arg 80 | eval "set -- ${args}" # update the shell's arguments with the new value 81 | 82 | 83 | # Check if file exists 84 | if [ ! -f "${MY_FILE}" ]; then 85 | >&2 echo "Error, File not found in: ${MY_FILE}" 86 | exit 1 87 | fi 88 | # Check if starting delimiter exists in file 89 | if ! grep -Fq "${DELIM_START}" "${MY_FILE}"; then 90 | >&2 echo "Error, Starting delimiter not found ${MY_FILE}: '${DELIM_START}'" 91 | exit 1 92 | fi 93 | # Check if closint delimiter exists in file 94 | if ! grep -Fq "${DELIM_CLOSE}" "${MY_FILE}"; then 95 | >&2 echo "Error, Closing delimiter not found ${MY_FILE}: '${DELIM_CLOSE}'" 96 | exit 1 97 | fi 98 | 99 | # Get owner and permissions of current file 100 | UID="$(stat -c %u "${MY_FILE}")" 101 | GID="$(stat -c %g "${MY_FILE}")" 102 | PERM="$(stat -c %a "${MY_FILE}")" 103 | 104 | # Remove first argument "replace" 105 | shift; 106 | # Get terraform-docs output 107 | >&2 echo "terraform-docs ${*} $(dirname "${MY_FILE}")" 108 | DOCS="$(terraform-docs "${@}" "$(dirname "${MY_FILE}")")" 109 | 110 | # Create temporary README.md 111 | mkdir -p /tmp 112 | grep -B 100000000 -F "${DELIM_START}" "${MY_FILE}" > /tmp/README.md 113 | printf "%s\\n\\n" "${DOCS}" >> /tmp/README.md 114 | grep -A 100000000 -F "${DELIM_CLOSE}" "${MY_FILE}" >> /tmp/README.md 115 | 116 | # Adjust permissions of temporary file 117 | chown "${UID}:${GID}" /tmp/README.md 118 | chmod "${PERM}" /tmp/README.md 119 | 120 | # Overwrite existing file 121 | mv -f /tmp/README.md "${MY_FILE}" 122 | exit 0 123 | 124 | ### 125 | ### terraform-docs command 126 | ### 127 | elif [ "${1}" = "terraform-docs" ] || [ "${1}" = "terraform-docs-012" ]; then 128 | 129 | # Remove first argument "replace" 130 | shift 131 | >&2 echo "terraform-docs ${*}" 132 | terraform-docs "${@}" 133 | 134 | ### 135 | ### Unsupported command 136 | ### 137 | else 138 | print_usage 139 | exit 1 140 | 141 | fi 142 | 143 | ### 144 | ### No arguments appended 145 | ### 146 | else 147 | exec terraform-docs --version 148 | fi 149 | -------------------------------------------------------------------------------- /Dockerfiles/data/docker-entrypoint-0.11.sh: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | set -e 4 | set -u 5 | 6 | 7 | ### 8 | ### Default variables 9 | ### 10 | DEF_DELIM_START='' 11 | DEF_DELIM_CLOSE='' 12 | 13 | 14 | ### 15 | ### Environment variables 16 | ### 17 | 18 | # Set delimiter 19 | if ! env | grep -q '^DELIM_START='; then 20 | DELIM_START="${DEF_DELIM_START}" 21 | fi 22 | if ! env | grep -q '^DELIM_CLOSE='; then 23 | DELIM_CLOSE="${DEF_DELIM_CLOSE}" 24 | fi 25 | 26 | 27 | ### 28 | ### Helper functions 29 | ### 30 | 31 | # Returns all but the last argument as an array using a POSIX-compliant method 32 | # for handling arrays. 33 | # Credit: https://gist.github.com/akutz/7a39159bbbe9c299c79f1d2107ef1357 34 | trim_last_arg() { 35 | _l="${#}" _i=0 _j="$((_l-1))" && while [ "${_i}" -lt "${_l}" ]; do 36 | if [ "${_i}" -lt "${_j}" ]; then 37 | printf '%s\n' "${1}" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" 38 | fi 39 | shift; _i="$((_i+1))" 40 | done 41 | echo " " 42 | } 43 | 44 | 45 | print_usage() { 46 | >&2 echo "Error, Unsupported command." 47 | >&2 echo "Usage: cytopia/terraform-docs terraform-docs ." 48 | >&2 echo " cytopia/terraform-docs terraform-docs-012 ." 49 | >&2 echo 50 | >&2 echo " cytopia/terraform-docs terraform-docs-replace " 51 | >&2 echo " cytopia/terraform-docs terraform-docs-replace-012 " 52 | >&2 echo 53 | >&2 echo 54 | >&2 echo "terraform-docs Output as expected from terraform-docs" 55 | >&2 echo "terraform-docs-012 Same as above, but used for Terraform >= 0.12 modules" 56 | >&2 echo 57 | >&2 echo "terraform-docs-replace Replaces directly inside README.md, if DELIM_START and DELIM_CLOSE are found." 58 | >&2 echo "terraform-docs-replace-012 Same as above, but used for Terraform >= 0.12 modules" 59 | >&2 echo 60 | >&2 echo " All arguments terraform-docs command can use." 61 | >&2 echo " File in where to auto-replace terraform-docs block." 62 | } 63 | 64 | 65 | ### 66 | ### Arguments appended? 67 | ### 68 | if [ "${#}" -ge "1" ]; then 69 | 70 | ### 71 | ### Custom replace operation 72 | ### 73 | if [ "${1}" = "terraform-docs-replace" ] || [ "${1}" = "terraform-docs-replace-012" ]; then 74 | 75 | # Store and Remove last argument (filename) 76 | eval MY_FILE="\${$#}" # store last argument 77 | args="$(trim_last_arg "${@}")" # get all the args except the last arg 78 | eval "set -- ${args}" # update the shell's arguments with the new value 79 | 80 | 81 | # Check if file exists 82 | if [ ! -f "${MY_FILE}" ]; then 83 | >&2 echo "Error, File not found in: ${MY_FILE}" 84 | exit 1 85 | fi 86 | # Check if starting delimiter exists in file 87 | if ! grep -Fq "${DELIM_START}" "${MY_FILE}"; then 88 | >&2 echo "Error, Starting delimiter not found ${MY_FILE}: '${DELIM_START}'" 89 | exit 1 90 | fi 91 | # Check if closint delimiter exists in file 92 | if ! grep -Fq "${DELIM_CLOSE}" "${MY_FILE}"; then 93 | >&2 echo "Error, Closing delimiter not found ${MY_FILE}: '${DELIM_CLOSE}'" 94 | exit 1 95 | fi 96 | 97 | # Get owner and permissions of current file 98 | UID="$(stat -c %u "${MY_FILE}")" 99 | GID="$(stat -c %g "${MY_FILE}")" 100 | PERM="$(stat -c %a "${MY_FILE}")" 101 | 102 | # Terraform < 0.12 103 | if [ "${1}" = "terraform-docs-replace" ]; then 104 | # Remove first argument "replace" 105 | shift; 106 | # Get terraform-docs output 107 | >&2 echo "terraform-docs ${*} $(dirname "${MY_FILE}")" 108 | DOCS="$(terraform-docs "${@}" "$(dirname "${MY_FILE}")")" 109 | # Terraform >= 0.12 110 | else 111 | # Remove first argument "replace" 112 | shift; 113 | mkdir -p /tmp-012 114 | awk -f /terraform-docs.awk -- "$(dirname "${MY_FILE}")/"*.tf > "/tmp-012/tmp.tf" 115 | # Get terraform-docs output 116 | >&2 echo "terraform-docs-012 ${*} $(dirname "${MY_FILE}")" 117 | if ! DOCS="$(terraform-docs "${@}" "/tmp-012")"; then 118 | cat -n "/tmp-012/tmp.tf" >&2 119 | exit 1 120 | fi 121 | fi 122 | 123 | # Create temporary README.md 124 | mkdir -p /tmp 125 | grep -B 100000000 -F "${DELIM_START}" "${MY_FILE}" > /tmp/README.md 126 | printf "%s\\n\\n" "${DOCS}" >> /tmp/README.md 127 | grep -A 100000000 -F "${DELIM_CLOSE}" "${MY_FILE}" >> /tmp/README.md 128 | 129 | # Adjust permissions of temporary file 130 | chown "${UID}:${GID}" /tmp/README.md 131 | chmod "${PERM}" /tmp/README.md 132 | 133 | # Overwrite existing file 134 | mv -f /tmp/README.md "${MY_FILE}" 135 | exit 0 136 | 137 | ### 138 | ### terraform-docs command 139 | ### 140 | elif [ "${1}" = "terraform-docs" ] || [ "${1}" = "terraform-docs-012" ]; then 141 | 142 | # Terraform < 0.12 143 | if [ "${1}" = "terraform-docs" ]; then 144 | >&2 echo "${*}" 145 | exec "${@}" 146 | 147 | # Terraform >= 0.12 148 | else 149 | 150 | # Store and Remove last argument (filename) 151 | eval MY_DIR="\${$#}" # store last argument 152 | args="$(trim_last_arg "${@}")" # get all the args except the last arg 153 | eval "set -- ${args}" # update the shell's arguments with the new value 154 | 155 | mkdir -p /tmp-012 156 | awk -f /terraform-docs.awk -- "${MY_DIR}/"*.tf > "/tmp-012/tmp.tf" 157 | 158 | # Remove first argument 159 | shift 160 | 161 | # Execute 162 | >&2 echo "terraform-docs ${*} ${MY_DIR}" 163 | if ! terraform-docs "${@}" "/tmp-012/"; then 164 | cat -n "/tmp-012/tmp.tf" >&2 165 | exit 1 166 | fi 167 | fi 168 | 169 | ### 170 | ### Unsupported command 171 | ### 172 | else 173 | print_usage 174 | exit 1 175 | 176 | fi 177 | 178 | ### 179 | ### No arguments appended 180 | ### 181 | else 182 | exec terraform-docs --version 183 | fi 184 | -------------------------------------------------------------------------------- /Dockerfiles/data/terraform-docs.awk: -------------------------------------------------------------------------------- 1 | # This script converts Terraform 0.12 variables/outputs to something suitable for `terraform-docs` 2 | # As of terraform-docs v0.6.0, HCL2 is not supported. This script is a *dirty hack* to get around it. 3 | # https://github.com/segmentio/terraform-docs/ 4 | # https://github.com/segmentio/terraform-docs/issues/62 5 | 6 | # Script was originally found here: https://github.com/cloudposse/build-harness/blob/master/bin/terraform-docs.awk 7 | 8 | { 9 | if ( $0 ~ /\{/ ) { 10 | braceCnt++ 11 | } 12 | 13 | if ( $0 ~ /\}/ ) { 14 | braceCnt-- 15 | } 16 | 17 | 18 | # ---------------------------------------------------------------------------------------------- 19 | # variable|output "..." { 20 | # ---------------------------------------------------------------------------------------------- 21 | # [END] variable/output block 22 | if (blockCnt > 0 && blockTypeCnt == 0 && blockDefaultCnt == 0) { 23 | if (braceCnt == 0 && blockCnt > 0) { 24 | blockCnt-- 25 | print $0 26 | } 27 | } 28 | # [START] variable or output block started 29 | if ($0 ~ /^[[:space:]]*(variable|output)[[:space:]][[:space:]]*"(.*?)"/) { 30 | # Normalize the braceCnt and block (should be 1 now) 31 | braceCnt = 1 32 | blockCnt = 1 33 | # [CLOSE] "default" and "type" block 34 | blockDefaultCnt = 0 35 | blockTypeCnt = 0 36 | # Print variable|output line 37 | print $0 38 | } 39 | 40 | 41 | # ---------------------------------------------------------------------------------------------- 42 | # default = ... 43 | # ---------------------------------------------------------------------------------------------- 44 | # [END] multiline "default" continues/ends 45 | if (blockCnt > 0 && blockTypeCnt == 0 && blockDefaultCnt > 0) { 46 | print $0 47 | # Count opening blocks 48 | blockDefaultCnt += gsub(/\(/, "") 49 | blockDefaultCnt += gsub(/\[/, "") 50 | blockDefaultCnt += gsub(/\{/, "") 51 | blockDefaultCnt += gsub(/\<\ 0 && blockTypeCnt == 0 && blockDefaultCnt == 0) { 60 | if ($0 ~ /^[[:space:]][[:space:]]*(default)[[:space:]][[:space:]]*=/) { 61 | if ($3 ~ "null") { 62 | print " default = \"null\"" 63 | } else { 64 | print $0 65 | # Count opening blocks 66 | blockDefaultCnt += gsub(/\(/, "") 67 | blockDefaultCnt += gsub(/\[/, "") 68 | blockDefaultCnt += gsub(/\{/, "") 69 | blockDefaultCnt += gsub(/\<\ 0 && blockTypeCnt > 0 && blockDefaultCnt == 0) { 85 | # The following 'print $0' would print multiline type definitions 86 | #print $0 87 | # Count opening blocks 88 | blockTypeCnt += gsub(/\(/, "") 89 | blockTypeCnt += gsub(/\[/, "") 90 | blockTypeCnt += gsub(/\{/, "") 91 | # Count closing blocks 92 | blockTypeCnt -= gsub(/\)/, "") 93 | blockTypeCnt -= gsub(/\]/, "") 94 | blockTypeCnt -= gsub(/\}/, "") 95 | } 96 | # [START] multiline "type" statement started 97 | if (blockCnt > 0 && blockTypeCnt == 0 && blockDefaultCnt == 0) { 98 | if ($0 ~ /^[[:space:]][[:space:]]*(type)[[:space:]][[:space:]]*=/ ) { 99 | if ($3 ~ "object") { 100 | print " type = \"object\"" 101 | } else { 102 | # Convert multiline stuff into single line 103 | if ($3 ~ /^[[:space:]]*list[[:space:]]*\([[:space:]]*$/) { 104 | type = "list" 105 | } else if ($3 ~ /^[[:space:]]*string[[:space:]]*\([[:space:]]*$/) { 106 | type = "string" 107 | } else if ($3 ~ /^[[:space:]]*map[[:space:]]*\([[:space:]]*$/) { 108 | type = "map" 109 | } else { 110 | type = $3 111 | } 112 | 113 | # legacy quoted types: "string", "list", and "map" 114 | if (type ~ /^[[:space:]]*"(.*?)"[[:space:]]*$/) { 115 | print " type = " type 116 | } else { 117 | print " type = \"" type "\"" 118 | } 119 | } 120 | # Count opening blocks 121 | blockTypeCnt += gsub(/\(/, "") 122 | blockTypeCnt += gsub(/\[/, "") 123 | blockTypeCnt += gsub(/\{/, "") 124 | # Count closing blocks 125 | blockTypeCnt -= gsub(/\)/, "") 126 | blockTypeCnt -= gsub(/\]/, "") 127 | blockTypeCnt -= gsub(/\}/, "") 128 | } 129 | } 130 | 131 | 132 | # ---------------------------------------------------------------------------------------------- 133 | # description = ... 134 | # ---------------------------------------------------------------------------------------------- 135 | # [END] multiline "description" continues/ends 136 | if (blockCtn > 0 && blockTypeCnt == 0 && blockDefaultCnt == 0) { 137 | # Count opening blocks 138 | blockDefaultCnt += gsub(/\<\ 0 && blockTypeCnt == 0 && blockDefaultCnt == 0) { 144 | if ($0 ~ /^[[:space:]][[:space:]]*description[[:space:]][[:space:]]*=/) { 145 | print $0 146 | # Count opening blocks 147 | blockDefaultCnt += gsub(/\<\ 0 && blockTypeCnt == 0 && blockDefaultCnt == 0) { 159 | # if ($0 ~ /^[[:space:]][[:space:]]*value[[:space:]][[:space:]]*=/) { 160 | # print $0 161 | # } 162 | #} 163 | 164 | 165 | # ---------------------------------------------------------------------------------------------- 166 | # Newlines, comments, everything else 167 | # ---------------------------------------------------------------------------------------------- 168 | #if (blockTypeCnt == 0 && blockDefaultCnt == 0) { 169 | # Comments with '#' 170 | if ($0 ~ /^[[:space:]]*#/) { 171 | print $0 172 | } 173 | # Comments with '//' 174 | if ($0 ~ /^[[:space:]]*\/\//) { 175 | print $0 176 | } 177 | # Newlines 178 | if ($0 ~ /^[[:space:]]*$/) { 179 | print $0 180 | } 181 | #} 182 | } 183 | -------------------------------------------------------------------------------- /tests/output/generate/default/TEST-0.1.0.md: -------------------------------------------------------------------------------- 1 | 2 | ## Inputs 3 | 4 | | Name | Description | Default | Required | 5 | |------|-------------|:-----:|:-----:| 6 | | allocated_storage | The allocated storage in gigabytes | - | yes | 7 | | allow_major_version_upgrade | Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible | `false` | no | 8 | | apply_immediately | Specifies whether any database modifications are applied immediately, or during the next maintenance window | `false` | no | 9 | | auto_minor_version_upgrade | Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window | `true` | no | 10 | | availability_zone | The Availability Zone of the RDS instance | `` | no | 11 | | backup_retention_period | The days to retain backups for | `7` | no | 12 | | backup_window | The daily time range (in UTC) during which automated backups are created if they are enabled. Example: '09:46-10:16'. Must not overlap with maintenance_window | - | yes | 13 | | character_set_name | (Optional) The character set name to use for DB encoding in Oracle instances. This can't be changed. See Oracle Character Sets Supported in Amazon RDS for more information | `` | no | 14 | | copy_tags_to_snapshot | On delete, copy all Instance tags to the final snapshot (if final_snapshot_identifier is specified) | `false` | no | 15 | | create_db_instance | Whether to create a database instance | `true` | no | 16 | | create_db_option_group | Whether to create a database option group | `true` | no | 17 | | create_db_parameter_group | Whether to create a database parameter group | `true` | no | 18 | | create_db_subnet_group | Whether to create a database subnet group | `true` | no | 19 | | create_monitoring_role | Create IAM role with a defined name that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. | `false` | no | 20 | | db_subnet_group_name | Name of DB subnet group. DB instance will be created in the VPC associated with the DB subnet group. If unspecified, will be created in the default VPC | `` | no | 21 | | deletion_protection | The database can't be deleted when this value is set to true. | `false` | no | 22 | | enabled_cloudwatch_logs_exports | List of log types to enable for exporting to CloudWatch logs. If omitted, no logs will be exported. Valid values (depending on engine): alert, audit, error, general, listener, slowquery, trace, postgresql (PostgreSQL), upgrade (PostgreSQL). | `` | no | 23 | | engine | The database engine to use | - | yes | 24 | | engine_version | The engine version to use | - | yes | 25 | | family | The family of the DB parameter group | `` | no | 26 | | final_snapshot_identifier | The name of your final DB snapshot when this DB instance is deleted. | `false` | no | 27 | | iam_database_authentication_enabled | Specifies whether or mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled | `false` | no | 28 | | identifier | The name of the RDS instance, if omitted, Terraform will assign a random, unique identifier | - | yes | 29 | | instance_class | The instance type of the RDS instance | - | yes | 30 | | iops | The amount of provisioned IOPS. Setting this implies a storage_type of 'io1' | `0` | no | 31 | | kms_key_id | The ARN for the KMS encryption key. If creating an encrypted replica, set this to the destination KMS ARN. If storage_encrypted is set to true and kms_key_id is not specified the default KMS key created in your account will be used | `` | no | 32 | | license_model | License model information for this DB instance. Optional, but required for some DB engines, i.e. Oracle SE1 | `` | no | 33 | | maintenance_window | The window to perform maintenance in. Syntax: 'ddd:hh24:mi-ddd:hh24:mi'. Eg: 'Mon:00:00-Mon:03:00' | - | yes | 34 | | major_engine_version | Specifies the major version of the engine that this option group should be associated with | `` | no | 35 | | monitoring_interval | The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. Valid Values: 0, 1, 5, 10, 15, 30, 60. | `0` | no | 36 | | monitoring_role_arn | The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. Must be specified if monitoring_interval is non-zero. | `` | no | 37 | | monitoring_role_name | Name of the IAM role which will be created when create_monitoring_role is enabled. | `rds-monitoring-role` | no | 38 | | multi_az | Specifies if the RDS instance is multi-AZ | `false` | no | 39 | | name | The DB schema name to create. If omitted, no database is created initially | `` | no | 40 | | option_group_description | The description of the option group | `` | no | 41 | | option_group_name | Name of the DB option group to associate. Setting this automatically disables option_group creation | `` | no | 42 | | options | A list of Options to apply. | `` | no | 43 | | parameter_group_description | Description of the DB parameter group to create | `` | no | 44 | | parameter_group_name | Name of the DB parameter group to associate or create | `` | no | 45 | | parameters | A list of DB parameters (map) to apply | `` | no | 46 | | password | Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file | - | yes | 47 | | port | The port on which the DB accepts connections | - | yes | 48 | | publicly_accessible | Bool to control if instance is publicly accessible | `false` | no | 49 | | replicate_source_db | Specifies that this resource is a Replicate database, and to use this value as the source database. This correlates to the identifier of another Amazon RDS Database to replicate. | `` | no | 50 | | skip_final_snapshot | Determines whether a final DB snapshot is created before the DB instance is deleted. If true is specified, no DBSnapshot is created. If false is specified, a DB snapshot is created before the DB instance is deleted, using the value from final_snapshot_identifier | `false` | no | 51 | | snapshot_identifier | Specifies whether or not to create this database from a snapshot. This correlates to the snapshot ID you'd find in the RDS console, e.g: rds:production-2015-06-26-06-05. | `` | no | 52 | | storage_encrypted | Specifies whether the DB instance is encrypted | `false` | no | 53 | | storage_type | One of 'standard' (magnetic), 'gp2' (general purpose SSD), or 'io1' (provisioned IOPS SSD). The default is 'io1' if iops is specified, 'standard' if not. Note that this behaviour is different from the AWS web console, where the default is 'gp2'. | `gp2` | no | 54 | | subnet_ids | A list of VPC subnet IDs | `` | no | 55 | | tags | A mapping of tags to assign to all resources | `` | no | 56 | | timeouts | (Optional) Updated Terraform resource management timeouts. Applies to `aws_db_instance` in particular to permit resource management times | `` | no | 57 | | timezone | (Optional) Time zone of the DB instance. timezone is currently only supported by Microsoft SQL Server. The timezone can only be set on creation. See MSSQL User Guide for more information. | `` | no | 58 | | use_option_group_name_prefix | Whether to use the option group name prefix or not | `true` | no | 59 | | use_parameter_group_name_prefix | Whether to use the parameter group name prefix or not | `true` | no | 60 | | use_subnet_group_name_prefix | Whether to use the subnet group name prefix or not | `true` | no | 61 | | username | Username for the master DB user | - | yes | 62 | | vpc_security_group_ids | List of VPC security groups to associate | `` | no | 63 | 64 | ## Outputs 65 | 66 | | Name | Description | 67 | |------|-------------| 68 | | this_db_instance_address | | 69 | | this_db_instance_arn | | 70 | | this_db_instance_availability_zone | | 71 | | this_db_instance_endpoint | | 72 | | this_db_instance_hosted_zone_id | | 73 | | this_db_instance_id | | 74 | | this_db_instance_name | | 75 | | this_db_instance_password | | 76 | | this_db_instance_port | | 77 | | this_db_instance_resource_id | | 78 | | this_db_instance_status | | 79 | | this_db_instance_username | | 80 | | this_db_option_group_arn | | 81 | | this_db_option_group_id | | 82 | | this_db_parameter_group_arn | | 83 | | this_db_parameter_group_id | # -------------------------------------------------------------------------------------------------- # RDS Parameter group # -------------------------------------------------------------------------------------------------- | 84 | | this_db_subnet_group_arn | | 85 | | this_db_subnet_group_id | | 86 | 87 | -------------------------------------------------------------------------------- /tests/output/replace/default/TEST-0.1.0.md: -------------------------------------------------------------------------------- 1 | # Test 2 | 3 | Stuff before terraform-docs 4 | 5 | 6 | 7 | ## Inputs 8 | 9 | | Name | Description | Default | Required | 10 | |------|-------------|:-----:|:-----:| 11 | | allocated_storage | The allocated storage in gigabytes | - | yes | 12 | | allow_major_version_upgrade | Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible | `false` | no | 13 | | apply_immediately | Specifies whether any database modifications are applied immediately, or during the next maintenance window | `false` | no | 14 | | auto_minor_version_upgrade | Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window | `true` | no | 15 | | availability_zone | The Availability Zone of the RDS instance | `` | no | 16 | | backup_retention_period | The days to retain backups for | `7` | no | 17 | | backup_window | The daily time range (in UTC) during which automated backups are created if they are enabled. Example: '09:46-10:16'. Must not overlap with maintenance_window | - | yes | 18 | | character_set_name | (Optional) The character set name to use for DB encoding in Oracle instances. This can't be changed. See Oracle Character Sets Supported in Amazon RDS for more information | `` | no | 19 | | copy_tags_to_snapshot | On delete, copy all Instance tags to the final snapshot (if final_snapshot_identifier is specified) | `false` | no | 20 | | create_db_instance | Whether to create a database instance | `true` | no | 21 | | create_db_option_group | Whether to create a database option group | `true` | no | 22 | | create_db_parameter_group | Whether to create a database parameter group | `true` | no | 23 | | create_db_subnet_group | Whether to create a database subnet group | `true` | no | 24 | | create_monitoring_role | Create IAM role with a defined name that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. | `false` | no | 25 | | db_subnet_group_name | Name of DB subnet group. DB instance will be created in the VPC associated with the DB subnet group. If unspecified, will be created in the default VPC | `` | no | 26 | | deletion_protection | The database can't be deleted when this value is set to true. | `false` | no | 27 | | enabled_cloudwatch_logs_exports | List of log types to enable for exporting to CloudWatch logs. If omitted, no logs will be exported. Valid values (depending on engine): alert, audit, error, general, listener, slowquery, trace, postgresql (PostgreSQL), upgrade (PostgreSQL). | `` | no | 28 | | engine | The database engine to use | - | yes | 29 | | engine_version | The engine version to use | - | yes | 30 | | family | The family of the DB parameter group | `` | no | 31 | | final_snapshot_identifier | The name of your final DB snapshot when this DB instance is deleted. | `false` | no | 32 | | iam_database_authentication_enabled | Specifies whether or mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled | `false` | no | 33 | | identifier | The name of the RDS instance, if omitted, Terraform will assign a random, unique identifier | - | yes | 34 | | instance_class | The instance type of the RDS instance | - | yes | 35 | | iops | The amount of provisioned IOPS. Setting this implies a storage_type of 'io1' | `0` | no | 36 | | kms_key_id | The ARN for the KMS encryption key. If creating an encrypted replica, set this to the destination KMS ARN. If storage_encrypted is set to true and kms_key_id is not specified the default KMS key created in your account will be used | `` | no | 37 | | license_model | License model information for this DB instance. Optional, but required for some DB engines, i.e. Oracle SE1 | `` | no | 38 | | maintenance_window | The window to perform maintenance in. Syntax: 'ddd:hh24:mi-ddd:hh24:mi'. Eg: 'Mon:00:00-Mon:03:00' | - | yes | 39 | | major_engine_version | Specifies the major version of the engine that this option group should be associated with | `` | no | 40 | | monitoring_interval | The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. Valid Values: 0, 1, 5, 10, 15, 30, 60. | `0` | no | 41 | | monitoring_role_arn | The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. Must be specified if monitoring_interval is non-zero. | `` | no | 42 | | monitoring_role_name | Name of the IAM role which will be created when create_monitoring_role is enabled. | `rds-monitoring-role` | no | 43 | | multi_az | Specifies if the RDS instance is multi-AZ | `false` | no | 44 | | name | The DB schema name to create. If omitted, no database is created initially | `` | no | 45 | | option_group_description | The description of the option group | `` | no | 46 | | option_group_name | Name of the DB option group to associate. Setting this automatically disables option_group creation | `` | no | 47 | | options | A list of Options to apply. | `` | no | 48 | | parameter_group_description | Description of the DB parameter group to create | `` | no | 49 | | parameter_group_name | Name of the DB parameter group to associate or create | `` | no | 50 | | parameters | A list of DB parameters (map) to apply | `` | no | 51 | | password | Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file | - | yes | 52 | | port | The port on which the DB accepts connections | - | yes | 53 | | publicly_accessible | Bool to control if instance is publicly accessible | `false` | no | 54 | | replicate_source_db | Specifies that this resource is a Replicate database, and to use this value as the source database. This correlates to the identifier of another Amazon RDS Database to replicate. | `` | no | 55 | | skip_final_snapshot | Determines whether a final DB snapshot is created before the DB instance is deleted. If true is specified, no DBSnapshot is created. If false is specified, a DB snapshot is created before the DB instance is deleted, using the value from final_snapshot_identifier | `false` | no | 56 | | snapshot_identifier | Specifies whether or not to create this database from a snapshot. This correlates to the snapshot ID you'd find in the RDS console, e.g: rds:production-2015-06-26-06-05. | `` | no | 57 | | storage_encrypted | Specifies whether the DB instance is encrypted | `false` | no | 58 | | storage_type | One of 'standard' (magnetic), 'gp2' (general purpose SSD), or 'io1' (provisioned IOPS SSD). The default is 'io1' if iops is specified, 'standard' if not. Note that this behaviour is different from the AWS web console, where the default is 'gp2'. | `gp2` | no | 59 | | subnet_ids | A list of VPC subnet IDs | `` | no | 60 | | tags | A mapping of tags to assign to all resources | `` | no | 61 | | timeouts | (Optional) Updated Terraform resource management timeouts. Applies to `aws_db_instance` in particular to permit resource management times | `` | no | 62 | | timezone | (Optional) Time zone of the DB instance. timezone is currently only supported by Microsoft SQL Server. The timezone can only be set on creation. See MSSQL User Guide for more information. | `` | no | 63 | | use_option_group_name_prefix | Whether to use the option group name prefix or not | `true` | no | 64 | | use_parameter_group_name_prefix | Whether to use the parameter group name prefix or not | `true` | no | 65 | | use_subnet_group_name_prefix | Whether to use the subnet group name prefix or not | `true` | no | 66 | | username | Username for the master DB user | - | yes | 67 | | vpc_security_group_ids | List of VPC security groups to associate | `` | no | 68 | 69 | ## Outputs 70 | 71 | | Name | Description | 72 | |------|-------------| 73 | | this_db_instance_address | | 74 | | this_db_instance_arn | | 75 | | this_db_instance_availability_zone | | 76 | | this_db_instance_endpoint | | 77 | | this_db_instance_hosted_zone_id | | 78 | | this_db_instance_id | | 79 | | this_db_instance_name | | 80 | | this_db_instance_password | | 81 | | this_db_instance_port | | 82 | | this_db_instance_resource_id | | 83 | | this_db_instance_status | | 84 | | this_db_instance_username | | 85 | | this_db_option_group_arn | | 86 | | this_db_option_group_id | | 87 | | this_db_parameter_group_arn | | 88 | | this_db_parameter_group_id | # -------------------------------------------------------------------------------------------------- # RDS Parameter group # -------------------------------------------------------------------------------------------------- | 89 | | this_db_subnet_group_arn | | 90 | | this_db_subnet_group_id | | 91 | 92 | 93 | 94 | Stuff after terraform-docs 95 | -------------------------------------------------------------------------------- /tests/output/generate/default/TEST-0.4.5.md: -------------------------------------------------------------------------------- 1 | ## Inputs 2 | 3 | | Name | Description | Type | Default | Required | 4 | |------|-------------|:----:|:-----:|:-----:| 5 | | allocated_storage | The allocated storage in gigabytes | string | - | yes | 6 | | allow_major_version_upgrade | Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible | string | `false` | no | 7 | | apply_immediately | Specifies whether any database modifications are applied immediately, or during the next maintenance window | string | `false` | no | 8 | | auto_minor_version_upgrade | Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window | string | `true` | no | 9 | | availability_zone | The Availability Zone of the RDS instance | string | `` | no | 10 | | backup_retention_period | The days to retain backups for | string | `7` | no | 11 | | backup_window | The daily time range (in UTC) during which automated backups are created if they are enabled. Example: '09:46-10:16'. Must not overlap with maintenance_window | string | - | yes | 12 | | character_set_name | (Optional) The character set name to use for DB encoding in Oracle instances. This can't be changed. See Oracle Character Sets Supported in Amazon RDS for more information | string | `` | no | 13 | | copy_tags_to_snapshot | On delete, copy all Instance tags to the final snapshot (if final_snapshot_identifier is specified) | string | `false` | no | 14 | | create_db_instance | Whether to create a database instance | string | `true` | no | 15 | | create_db_option_group | Whether to create a database option group | string | `true` | no | 16 | | create_db_parameter_group | Whether to create a database parameter group | string | `true` | no | 17 | | create_db_subnet_group | Whether to create a database subnet group | string | `true` | no | 18 | | create_monitoring_role | Create IAM role with a defined name that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. | string | `false` | no | 19 | | db_subnet_group_name | Name of DB subnet group. DB instance will be created in the VPC associated with the DB subnet group. If unspecified, will be created in the default VPC | string | `` | no | 20 | | deletion_protection | The database can't be deleted when this value is set to true. | string | `false` | no | 21 | | enabled_cloudwatch_logs_exports | List of log types to enable for exporting to CloudWatch logs. If omitted, no logs will be exported. Valid values (depending on engine): alert, audit, error, general, listener, slowquery, trace, postgresql (PostgreSQL), upgrade (PostgreSQL). | list | `[]` | no | 22 | | engine | The database engine to use | string | - | yes | 23 | | engine_version | The engine version to use | string | - | yes | 24 | | family | The family of the DB parameter group | string | `` | no | 25 | | final_snapshot_identifier | The name of your final DB snapshot when this DB instance is deleted. | string | `false` | no | 26 | | iam_database_authentication_enabled | Specifies whether or mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled | string | `false` | no | 27 | | identifier | The name of the RDS instance, if omitted, Terraform will assign a random, unique identifier | string | - | yes | 28 | | instance_class | The instance type of the RDS instance | string | - | yes | 29 | | iops | The amount of provisioned IOPS. Setting this implies a storage_type of 'io1' | string | `0` | no | 30 | | kms_key_id | The ARN for the KMS encryption key. If creating an encrypted replica, set this to the destination KMS ARN. If storage_encrypted is set to true and kms_key_id is not specified the default KMS key created in your account will be used | string | `` | no | 31 | | license_model | License model information for this DB instance. Optional, but required for some DB engines, i.e. Oracle SE1 | string | `` | no | 32 | | maintenance_window | The window to perform maintenance in. Syntax: 'ddd:hh24:mi-ddd:hh24:mi'. Eg: 'Mon:00:00-Mon:03:00' | string | - | yes | 33 | | major_engine_version | Specifies the major version of the engine that this option group should be associated with | string | `` | no | 34 | | monitoring_interval | The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. Valid Values: 0, 1, 5, 10, 15, 30, 60. | string | `0` | no | 35 | | monitoring_role_arn | The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. Must be specified if monitoring_interval is non-zero. | string | `` | no | 36 | | monitoring_role_name | Name of the IAM role which will be created when create_monitoring_role is enabled. | string | `rds-monitoring-role` | no | 37 | | multi_az | Specifies if the RDS instance is multi-AZ | string | `false` | no | 38 | | name | The DB schema name to create. If omitted, no database is created initially | string | `` | no | 39 | | option_group_description | The description of the option group | string | `` | no | 40 | | option_group_name | Name of the DB option group to associate. Setting this automatically disables option_group creation | string | `` | no | 41 | | options | A list of Options to apply. | list | `[]` | no | 42 | | parameter_group_description | Description of the DB parameter group to create | string | `` | no | 43 | | parameter_group_name | Name of the DB parameter group to associate or create | string | `` | no | 44 | | parameters | A list of DB parameters (map) to apply | list | `[]` | no | 45 | | password | Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file | string | - | yes | 46 | | port | The port on which the DB accepts connections | string | - | yes | 47 | | publicly_accessible | Bool to control if instance is publicly accessible | string | `false` | no | 48 | | replicate_source_db | Specifies that this resource is a Replicate database, and to use this value as the source database. This correlates to the identifier of another Amazon RDS Database to replicate. | string | `` | no | 49 | | skip_final_snapshot | Determines whether a final DB snapshot is created before the DB instance is deleted. If true is specified, no DBSnapshot is created. If false is specified, a DB snapshot is created before the DB instance is deleted, using the value from final_snapshot_identifier | string | `false` | no | 50 | | snapshot_identifier | Specifies whether or not to create this database from a snapshot. This correlates to the snapshot ID you'd find in the RDS console, e.g: rds:production-2015-06-26-06-05. | string | `` | no | 51 | | storage_encrypted | Specifies whether the DB instance is encrypted | string | `false` | no | 52 | | storage_type | One of 'standard' (magnetic), 'gp2' (general purpose SSD), or 'io1' (provisioned IOPS SSD). The default is 'io1' if iops is specified, 'standard' if not. Note that this behaviour is different from the AWS web console, where the default is 'gp2'. | string | `gp2` | no | 53 | | subnet_ids | A list of VPC subnet IDs | list | `[]` | no | 54 | | tags | A mapping of tags to assign to all resources | map | `{}` | no | 55 | | timeouts | (Optional) Updated Terraform resource management timeouts. Applies to `aws_db_instance` in particular to permit resource management times | map | `{ "create": "40m", "delete": "40m", "update": "80m" }` | no | 56 | | timezone | (Optional) Time zone of the DB instance. timezone is currently only supported by Microsoft SQL Server. The timezone can only be set on creation. See MSSQL User Guide for more information. | string | `` | no | 57 | | use_option_group_name_prefix | Whether to use the option group name prefix or not | string | `true` | no | 58 | | use_parameter_group_name_prefix | Whether to use the parameter group name prefix or not | string | `true` | no | 59 | | use_subnet_group_name_prefix | Whether to use the subnet group name prefix or not | string | `true` | no | 60 | | username | Username for the master DB user | string | - | yes | 61 | | vpc_security_group_ids | List of VPC security groups to associate | list | `[]` | no | 62 | 63 | ## Outputs 64 | 65 | | Name | Description | 66 | |------|-------------| 67 | | this_db_instance_address | The address of the RDS instance | 68 | | this_db_instance_arn | The ARN of the RDS instance | 69 | | this_db_instance_availability_zone | The availability zone of the RDS instance | 70 | | this_db_instance_endpoint | The connection endpoint | 71 | | this_db_instance_hosted_zone_id | The canonical hosted zone ID of the DB instance (to be used in a Route 53 Alias record) | 72 | | this_db_instance_id | The RDS instance ID | 73 | | this_db_instance_name | The database name | 74 | | this_db_instance_password | The database password (this password may be old, because Terraform doesn't track it after initial creation) | 75 | | this_db_instance_port | The database port | 76 | | this_db_instance_resource_id | The RDS Resource ID of this instance | 77 | | this_db_instance_status | The RDS instance status | 78 | | this_db_instance_username | The master username for the database | 79 | | this_db_option_group_arn | The ARN of the db option group | 80 | | this_db_option_group_id | The db option group id | 81 | | this_db_parameter_group_arn | The ARN of the db parameter group | 82 | | this_db_parameter_group_id | The db parameter group id | 83 | | this_db_subnet_group_arn | The ARN of the db subnet group | 84 | | this_db_subnet_group_id | The db subnet group id | 85 | 86 | -------------------------------------------------------------------------------- /tests/output/generate/default/TEST-0.4.0.md: -------------------------------------------------------------------------------- 1 | 2 | ## Inputs 3 | 4 | | Name | Description | Type | Default | Required | 5 | |------|-------------|:----:|:-----:|:-----:| 6 | | allocated_storage | The allocated storage in gigabytes | string | - | yes | 7 | | allow_major_version_upgrade | Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible | string | `false` | no | 8 | | apply_immediately | Specifies whether any database modifications are applied immediately, or during the next maintenance window | string | `false` | no | 9 | | auto_minor_version_upgrade | Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window | string | `true` | no | 10 | | availability_zone | The Availability Zone of the RDS instance | string | `` | no | 11 | | backup_retention_period | The days to retain backups for | string | `7` | no | 12 | | backup_window | The daily time range (in UTC) during which automated backups are created if they are enabled. Example: '09:46-10:16'. Must not overlap with maintenance_window | string | - | yes | 13 | | character_set_name | (Optional) The character set name to use for DB encoding in Oracle instances. This can't be changed. See Oracle Character Sets Supported in Amazon RDS for more information | string | `` | no | 14 | | copy_tags_to_snapshot | On delete, copy all Instance tags to the final snapshot (if final_snapshot_identifier is specified) | string | `false` | no | 15 | | create_db_instance | Whether to create a database instance | string | `true` | no | 16 | | create_db_option_group | Whether to create a database option group | string | `true` | no | 17 | | create_db_parameter_group | Whether to create a database parameter group | string | `true` | no | 18 | | create_db_subnet_group | Whether to create a database subnet group | string | `true` | no | 19 | | create_monitoring_role | Create IAM role with a defined name that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. | string | `false` | no | 20 | | db_subnet_group_name | Name of DB subnet group. DB instance will be created in the VPC associated with the DB subnet group. If unspecified, will be created in the default VPC | string | `` | no | 21 | | deletion_protection | The database can't be deleted when this value is set to true. | string | `false` | no | 22 | | enabled_cloudwatch_logs_exports | List of log types to enable for exporting to CloudWatch logs. If omitted, no logs will be exported. Valid values (depending on engine): alert, audit, error, general, listener, slowquery, trace, postgresql (PostgreSQL), upgrade (PostgreSQL). | list | `[]` | no | 23 | | engine | The database engine to use | string | - | yes | 24 | | engine_version | The engine version to use | string | - | yes | 25 | | family | The family of the DB parameter group | string | `` | no | 26 | | final_snapshot_identifier | The name of your final DB snapshot when this DB instance is deleted. | string | `false` | no | 27 | | iam_database_authentication_enabled | Specifies whether or mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled | string | `false` | no | 28 | | identifier | The name of the RDS instance, if omitted, Terraform will assign a random, unique identifier | string | - | yes | 29 | | instance_class | The instance type of the RDS instance | string | - | yes | 30 | | iops | The amount of provisioned IOPS. Setting this implies a storage_type of 'io1' | string | `0` | no | 31 | | kms_key_id | The ARN for the KMS encryption key. If creating an encrypted replica, set this to the destination KMS ARN. If storage_encrypted is set to true and kms_key_id is not specified the default KMS key created in your account will be used | string | `` | no | 32 | | license_model | License model information for this DB instance. Optional, but required for some DB engines, i.e. Oracle SE1 | string | `` | no | 33 | | maintenance_window | The window to perform maintenance in. Syntax: 'ddd:hh24:mi-ddd:hh24:mi'. Eg: 'Mon:00:00-Mon:03:00' | string | - | yes | 34 | | major_engine_version | Specifies the major version of the engine that this option group should be associated with | string | `` | no | 35 | | monitoring_interval | The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. Valid Values: 0, 1, 5, 10, 15, 30, 60. | string | `0` | no | 36 | | monitoring_role_arn | The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. Must be specified if monitoring_interval is non-zero. | string | `` | no | 37 | | monitoring_role_name | Name of the IAM role which will be created when create_monitoring_role is enabled. | string | `rds-monitoring-role` | no | 38 | | multi_az | Specifies if the RDS instance is multi-AZ | string | `false` | no | 39 | | name | The DB schema name to create. If omitted, no database is created initially | string | `` | no | 40 | | option_group_description | The description of the option group | string | `` | no | 41 | | option_group_name | Name of the DB option group to associate. Setting this automatically disables option_group creation | string | `` | no | 42 | | options | A list of Options to apply. | list | `[]` | no | 43 | | parameter_group_description | Description of the DB parameter group to create | string | `` | no | 44 | | parameter_group_name | Name of the DB parameter group to associate or create | string | `` | no | 45 | | parameters | A list of DB parameters (map) to apply | list | `[]` | no | 46 | | password | Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file | string | - | yes | 47 | | port | The port on which the DB accepts connections | string | - | yes | 48 | | publicly_accessible | Bool to control if instance is publicly accessible | string | `false` | no | 49 | | replicate_source_db | Specifies that this resource is a Replicate database, and to use this value as the source database. This correlates to the identifier of another Amazon RDS Database to replicate. | string | `` | no | 50 | | skip_final_snapshot | Determines whether a final DB snapshot is created before the DB instance is deleted. If true is specified, no DBSnapshot is created. If false is specified, a DB snapshot is created before the DB instance is deleted, using the value from final_snapshot_identifier | string | `false` | no | 51 | | snapshot_identifier | Specifies whether or not to create this database from a snapshot. This correlates to the snapshot ID you'd find in the RDS console, e.g: rds:production-2015-06-26-06-05. | string | `` | no | 52 | | storage_encrypted | Specifies whether the DB instance is encrypted | string | `false` | no | 53 | | storage_type | One of 'standard' (magnetic), 'gp2' (general purpose SSD), or 'io1' (provisioned IOPS SSD). The default is 'io1' if iops is specified, 'standard' if not. Note that this behaviour is different from the AWS web console, where the default is 'gp2'. | string | `gp2` | no | 54 | | subnet_ids | A list of VPC subnet IDs | list | `[]` | no | 55 | | tags | A mapping of tags to assign to all resources | map | `{}` | no | 56 | | timeouts | (Optional) Updated Terraform resource management timeouts. Applies to `aws_db_instance` in particular to permit resource management times | map | `{ "create": "40m", "delete": "40m", "update": "80m" }` | no | 57 | | timezone | (Optional) Time zone of the DB instance. timezone is currently only supported by Microsoft SQL Server. The timezone can only be set on creation. See MSSQL User Guide for more information. | string | `` | no | 58 | | use_option_group_name_prefix | Whether to use the option group name prefix or not | string | `true` | no | 59 | | use_parameter_group_name_prefix | Whether to use the parameter group name prefix or not | string | `true` | no | 60 | | use_subnet_group_name_prefix | Whether to use the subnet group name prefix or not | string | `true` | no | 61 | | username | Username for the master DB user | string | - | yes | 62 | | vpc_security_group_ids | List of VPC security groups to associate | list | `[]` | no | 63 | 64 | ## Outputs 65 | 66 | | Name | Description | 67 | |------|-------------| 68 | | this_db_instance_address | The address of the RDS instance | 69 | | this_db_instance_arn | The ARN of the RDS instance | 70 | | this_db_instance_availability_zone | The availability zone of the RDS instance | 71 | | this_db_instance_endpoint | The connection endpoint | 72 | | this_db_instance_hosted_zone_id | The canonical hosted zone ID of the DB instance (to be used in a Route 53 Alias record) | 73 | | this_db_instance_id | The RDS instance ID | 74 | | this_db_instance_name | The database name | 75 | | this_db_instance_password | The database password (this password may be old, because Terraform doesn't track it after initial creation) | 76 | | this_db_instance_port | The database port | 77 | | this_db_instance_resource_id | The RDS Resource ID of this instance | 78 | | this_db_instance_status | The RDS instance status | 79 | | this_db_instance_username | The master username for the database | 80 | | this_db_option_group_arn | The ARN of the db option group | 81 | | this_db_option_group_id | The db option group id | 82 | | this_db_parameter_group_arn | The ARN of the db parameter group | 83 | | this_db_parameter_group_id | The db parameter group id | 84 | | this_db_subnet_group_arn | The ARN of the db subnet group | 85 | | this_db_subnet_group_id | The db subnet group id | 86 | 87 | -------------------------------------------------------------------------------- /tests/output/generate/default/TEST-0.5.0.md: -------------------------------------------------------------------------------- 1 | ## Inputs 2 | 3 | | Name | Description | Type | Default | Required | 4 | |------|-------------|:----:|:-----:|:-----:| 5 | | allocated\_storage | The allocated storage in gigabytes | string | - | yes | 6 | | backup\_window | The daily time range (in UTC) during which automated backups are created if they are enabled. Example: '09:46-10:16'. Must not overlap with maintenance_window | string | - | yes | 7 | | engine | The database engine to use | string | - | yes | 8 | | engine\_version | The engine version to use | string | - | yes | 9 | | identifier | The name of the RDS instance, if omitted, Terraform will assign a random, unique identifier | string | - | yes | 10 | | instance\_class | The instance type of the RDS instance | string | - | yes | 11 | | maintenance\_window | The window to perform maintenance in. Syntax: 'ddd:hh24:mi-ddd:hh24:mi'. Eg: 'Mon:00:00-Mon:03:00' | string | - | yes | 12 | | password | Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file | string | - | yes | 13 | | port | The port on which the DB accepts connections | string | - | yes | 14 | | username | Username for the master DB user | string | - | yes | 15 | | allow\_major\_version\_upgrade | Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible | string | `false` | no | 16 | | apply\_immediately | Specifies whether any database modifications are applied immediately, or during the next maintenance window | string | `false` | no | 17 | | auto\_minor\_version\_upgrade | Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window | string | `true` | no | 18 | | availability\_zone | The Availability Zone of the RDS instance | string | `` | no | 19 | | backup\_retention\_period | The days to retain backups for | string | `7` | no | 20 | | character\_set\_name | (Optional) The character set name to use for DB encoding in Oracle instances. This can't be changed. See Oracle Character Sets Supported in Amazon RDS for more information | string | `` | no | 21 | | copy\_tags\_to\_snapshot | On delete, copy all Instance tags to the final snapshot (if final_snapshot_identifier is specified) | string | `false` | no | 22 | | create\_db\_instance | Whether to create a database instance | string | `true` | no | 23 | | create\_db\_option\_group | Whether to create a database option group | string | `true` | no | 24 | | create\_db\_parameter\_group | Whether to create a database parameter group | string | `true` | no | 25 | | create\_db\_subnet\_group | Whether to create a database subnet group | string | `true` | no | 26 | | create\_monitoring\_role | Create IAM role with a defined name that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. | string | `false` | no | 27 | | db\_subnet\_group\_name | Name of DB subnet group. DB instance will be created in the VPC associated with the DB subnet group. If unspecified, will be created in the default VPC | string | `` | no | 28 | | deletion\_protection | The database can't be deleted when this value is set to true. | string | `false` | no | 29 | | enabled\_cloudwatch\_logs\_exports | List of log types to enable for exporting to CloudWatch logs. If omitted, no logs will be exported. Valid values (depending on engine): alert, audit, error, general, listener, slowquery, trace, postgresql (PostgreSQL), upgrade (PostgreSQL). | list | `[]` | no | 30 | | family | The family of the DB parameter group | string | `` | no | 31 | | final\_snapshot\_identifier | The name of your final DB snapshot when this DB instance is deleted. | string | `false` | no | 32 | | iam\_database\_authentication\_enabled | Specifies whether or mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled | string | `false` | no | 33 | | iops | The amount of provisioned IOPS. Setting this implies a storage_type of 'io1' | string | `0` | no | 34 | | kms\_key\_id | The ARN for the KMS encryption key. If creating an encrypted replica, set this to the destination KMS ARN. If storage_encrypted is set to true and kms_key_id is not specified the default KMS key created in your account will be used | string | `` | no | 35 | | license\_model | License model information for this DB instance. Optional, but required for some DB engines, i.e. Oracle SE1 | string | `` | no | 36 | | major\_engine\_version | Specifies the major version of the engine that this option group should be associated with | string | `` | no | 37 | | monitoring\_interval | The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. Valid Values: 0, 1, 5, 10, 15, 30, 60. | string | `0` | no | 38 | | monitoring\_role\_arn | The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. Must be specified if monitoring_interval is non-zero. | string | `` | no | 39 | | monitoring\_role\_name | Name of the IAM role which will be created when create_monitoring_role is enabled. | string | `rds-monitoring-role` | no | 40 | | multi\_az | Specifies if the RDS instance is multi-AZ | string | `false` | no | 41 | | name | The DB schema name to create. If omitted, no database is created initially | string | `` | no | 42 | | option\_group\_description | The description of the option group | string | `` | no | 43 | | option\_group\_name | Name of the DB option group to associate. Setting this automatically disables option_group creation | string | `` | no | 44 | | options | A list of Options to apply. | list | `[]` | no | 45 | | parameter\_group\_description | Description of the DB parameter group to create | string | `` | no | 46 | | parameter\_group\_name | Name of the DB parameter group to associate or create | string | `` | no | 47 | | parameters | A list of DB parameters (map) to apply | list | `[]` | no | 48 | | publicly\_accessible | Bool to control if instance is publicly accessible | string | `false` | no | 49 | | replicate\_source\_db | Specifies that this resource is a Replicate database, and to use this value as the source database. This correlates to the identifier of another Amazon RDS Database to replicate. | string | `` | no | 50 | | skip\_final\_snapshot | Determines whether a final DB snapshot is created before the DB instance is deleted. If true is specified, no DBSnapshot is created. If false is specified, a DB snapshot is created before the DB instance is deleted, using the value from final_snapshot_identifier | string | `false` | no | 51 | | snapshot\_identifier | Specifies whether or not to create this database from a snapshot. This correlates to the snapshot ID you'd find in the RDS console, e.g: rds:production-2015-06-26-06-05. | string | `` | no | 52 | | storage\_encrypted | Specifies whether the DB instance is encrypted | string | `false` | no | 53 | | storage\_type | One of 'standard' (magnetic), 'gp2' (general purpose SSD), or 'io1' (provisioned IOPS SSD). The default is 'io1' if iops is specified, 'standard' if not. Note that this behaviour is different from the AWS web console, where the default is 'gp2'. | string | `gp2` | no | 54 | | subnet\_ids | A list of VPC subnet IDs | list | `[]` | no | 55 | | tags | A mapping of tags to assign to all resources | map | `{}` | no | 56 | | timeouts | (Optional) Updated Terraform resource management timeouts. Applies to `aws_db_instance` in particular to permit resource management times | map | `{ "create": "40m", "delete": "40m", "update": "80m" }` | no | 57 | | timezone | (Optional) Time zone of the DB instance. timezone is currently only supported by Microsoft SQL Server. The timezone can only be set on creation. See MSSQL User Guide for more information. | string | `` | no | 58 | | use\_option\_group\_name\_prefix | Whether to use the option group name prefix or not | string | `true` | no | 59 | | use\_parameter\_group\_name\_prefix | Whether to use the parameter group name prefix or not | string | `true` | no | 60 | | use\_subnet\_group\_name\_prefix | Whether to use the subnet group name prefix or not | string | `true` | no | 61 | | vpc\_security\_group\_ids | List of VPC security groups to associate | list | `[]` | no | 62 | 63 | ## Outputs 64 | 65 | | Name | Description | 66 | |------|-------------| 67 | | this\_db\_instance\_address | The address of the RDS instance | 68 | | this\_db\_instance\_arn | The ARN of the RDS instance | 69 | | this\_db\_instance\_availability\_zone | The availability zone of the RDS instance | 70 | | this\_db\_instance\_endpoint | The connection endpoint | 71 | | this\_db\_instance\_hosted\_zone\_id | The canonical hosted zone ID of the DB instance (to be used in a Route 53 Alias record) | 72 | | this\_db\_instance\_id | The RDS instance ID | 73 | | this\_db\_instance\_name | The database name | 74 | | this\_db\_instance\_password | The database password (this password may be old, because Terraform doesn't track it after initial creation) | 75 | | this\_db\_instance\_port | The database port | 76 | | this\_db\_instance\_resource\_id | The RDS Resource ID of this instance | 77 | | this\_db\_instance\_status | The RDS instance status | 78 | | this\_db\_instance\_username | The master username for the database | 79 | | this\_db\_option\_group\_arn | The ARN of the db option group | 80 | | this\_db\_option\_group\_id | The db option group id | 81 | | this\_db\_parameter\_group\_arn | The ARN of the db parameter group | 82 | | this\_db\_parameter\_group\_id | The db parameter group id | 83 | | this\_db\_subnet\_group\_arn | The ARN of the db subnet group | 84 | | this\_db\_subnet\_group\_id | The db subnet group id | 85 | 86 | -------------------------------------------------------------------------------- /tests/output/generate/default/TEST-0.1.1.md: -------------------------------------------------------------------------------- 1 | 2 | ## Inputs 3 | 4 | | Name | Description | Type | Default | Required | 5 | |------|-------------|:----:|:-----:|:-----:| 6 | | allocated_storage | The allocated storage in gigabytes | string | - | yes | 7 | | allow_major_version_upgrade | Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible | string | `false` | no | 8 | | apply_immediately | Specifies whether any database modifications are applied immediately, or during the next maintenance window | string | `false` | no | 9 | | auto_minor_version_upgrade | Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window | string | `true` | no | 10 | | availability_zone | The Availability Zone of the RDS instance | string | `` | no | 11 | | backup_retention_period | The days to retain backups for | string | `7` | no | 12 | | backup_window | The daily time range (in UTC) during which automated backups are created if they are enabled. Example: '09:46-10:16'. Must not overlap with maintenance_window | string | - | yes | 13 | | character_set_name | (Optional) The character set name to use for DB encoding in Oracle instances. This can't be changed. See Oracle Character Sets Supported in Amazon RDS for more information | string | `` | no | 14 | | copy_tags_to_snapshot | On delete, copy all Instance tags to the final snapshot (if final_snapshot_identifier is specified) | string | `false` | no | 15 | | create_db_instance | Whether to create a database instance | string | `true` | no | 16 | | create_db_option_group | Whether to create a database option group | string | `true` | no | 17 | | create_db_parameter_group | Whether to create a database parameter group | string | `true` | no | 18 | | create_db_subnet_group | Whether to create a database subnet group | string | `true` | no | 19 | | create_monitoring_role | Create IAM role with a defined name that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. | string | `false` | no | 20 | | db_subnet_group_name | Name of DB subnet group. DB instance will be created in the VPC associated with the DB subnet group. If unspecified, will be created in the default VPC | string | `` | no | 21 | | deletion_protection | The database can't be deleted when this value is set to true. | string | `false` | no | 22 | | enabled_cloudwatch_logs_exports | List of log types to enable for exporting to CloudWatch logs. If omitted, no logs will be exported. Valid values (depending on engine): alert, audit, error, general, listener, slowquery, trace, postgresql (PostgreSQL), upgrade (PostgreSQL). | string | `` | no | 23 | | engine | The database engine to use | string | - | yes | 24 | | engine_version | The engine version to use | string | - | yes | 25 | | family | The family of the DB parameter group | string | `` | no | 26 | | final_snapshot_identifier | The name of your final DB snapshot when this DB instance is deleted. | string | `false` | no | 27 | | iam_database_authentication_enabled | Specifies whether or mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled | string | `false` | no | 28 | | identifier | The name of the RDS instance, if omitted, Terraform will assign a random, unique identifier | string | - | yes | 29 | | instance_class | The instance type of the RDS instance | string | - | yes | 30 | | iops | The amount of provisioned IOPS. Setting this implies a storage_type of 'io1' | string | `0` | no | 31 | | kms_key_id | The ARN for the KMS encryption key. If creating an encrypted replica, set this to the destination KMS ARN. If storage_encrypted is set to true and kms_key_id is not specified the default KMS key created in your account will be used | string | `` | no | 32 | | license_model | License model information for this DB instance. Optional, but required for some DB engines, i.e. Oracle SE1 | string | `` | no | 33 | | maintenance_window | The window to perform maintenance in. Syntax: 'ddd:hh24:mi-ddd:hh24:mi'. Eg: 'Mon:00:00-Mon:03:00' | string | - | yes | 34 | | major_engine_version | Specifies the major version of the engine that this option group should be associated with | string | `` | no | 35 | | monitoring_interval | The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. Valid Values: 0, 1, 5, 10, 15, 30, 60. | string | `0` | no | 36 | | monitoring_role_arn | The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. Must be specified if monitoring_interval is non-zero. | string | `` | no | 37 | | monitoring_role_name | Name of the IAM role which will be created when create_monitoring_role is enabled. | string | `rds-monitoring-role` | no | 38 | | multi_az | Specifies if the RDS instance is multi-AZ | string | `false` | no | 39 | | name | The DB schema name to create. If omitted, no database is created initially | string | `` | no | 40 | | option_group_description | The description of the option group | string | `` | no | 41 | | option_group_name | Name of the DB option group to associate. Setting this automatically disables option_group creation | string | `` | no | 42 | | options | A list of Options to apply. | list | `` | no | 43 | | parameter_group_description | Description of the DB parameter group to create | string | `` | no | 44 | | parameter_group_name | Name of the DB parameter group to associate or create | string | `` | no | 45 | | parameters | A list of DB parameters (map) to apply | string | `` | no | 46 | | password | Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file | string | - | yes | 47 | | port | The port on which the DB accepts connections | string | - | yes | 48 | | publicly_accessible | Bool to control if instance is publicly accessible | string | `false` | no | 49 | | replicate_source_db | Specifies that this resource is a Replicate database, and to use this value as the source database. This correlates to the identifier of another Amazon RDS Database to replicate. | string | `` | no | 50 | | skip_final_snapshot | Determines whether a final DB snapshot is created before the DB instance is deleted. If true is specified, no DBSnapshot is created. If false is specified, a DB snapshot is created before the DB instance is deleted, using the value from final_snapshot_identifier | string | `false` | no | 51 | | snapshot_identifier | Specifies whether or not to create this database from a snapshot. This correlates to the snapshot ID you'd find in the RDS console, e.g: rds:production-2015-06-26-06-05. | string | `` | no | 52 | | storage_encrypted | Specifies whether the DB instance is encrypted | string | `false` | no | 53 | | storage_type | One of 'standard' (magnetic), 'gp2' (general purpose SSD), or 'io1' (provisioned IOPS SSD). The default is 'io1' if iops is specified, 'standard' if not. Note that this behaviour is different from the AWS web console, where the default is 'gp2'. | string | `gp2` | no | 54 | | subnet_ids | A list of VPC subnet IDs | list | `` | no | 55 | | tags | A mapping of tags to assign to all resources | string | `` | no | 56 | | timeouts | (Optional) Updated Terraform resource management timeouts. Applies to `aws_db_instance` in particular to permit resource management times | map | `` | no | 57 | | timezone | (Optional) Time zone of the DB instance. timezone is currently only supported by Microsoft SQL Server. The timezone can only be set on creation. See MSSQL User Guide for more information. | string | `` | no | 58 | | use_option_group_name_prefix | Whether to use the option group name prefix or not | string | `true` | no | 59 | | use_parameter_group_name_prefix | Whether to use the parameter group name prefix or not | string | `true` | no | 60 | | use_subnet_group_name_prefix | Whether to use the subnet group name prefix or not | string | `true` | no | 61 | | username | Username for the master DB user | string | - | yes | 62 | | vpc_security_group_ids | List of VPC security groups to associate | string | `` | no | 63 | 64 | ## Outputs 65 | 66 | | Name | Description | 67 | |------|-------------| 68 | | this_db_instance_address | The address of the RDS instance | 69 | | this_db_instance_arn | The ARN of the RDS instance | 70 | | this_db_instance_availability_zone | The availability zone of the RDS instance | 71 | | this_db_instance_endpoint | The connection endpoint | 72 | | this_db_instance_hosted_zone_id | The canonical hosted zone ID of the DB instance (to be used in a Route 53 Alias record) | 73 | | this_db_instance_id | The RDS instance ID | 74 | | this_db_instance_name | The database name | 75 | | this_db_instance_password | The database password (this password may be old, because Terraform doesn't track it after initial creation) | 76 | | this_db_instance_port | The database port | 77 | | this_db_instance_resource_id | The RDS Resource ID of this instance | 78 | | this_db_instance_status | The RDS instance status | 79 | | this_db_instance_username | The master username for the database | 80 | | this_db_option_group_arn | The ARN of the db option group | 81 | | this_db_option_group_id | The db option group id | 82 | | this_db_parameter_group_arn | The ARN of the db parameter group | 83 | | this_db_parameter_group_id | -------------------------------------------------------------------------------------------------- RDS Parameter group -------------------------------------------------------------------------------------------------- | 84 | | this_db_subnet_group_arn | The ARN of the db subnet group | 85 | | this_db_subnet_group_id | The db subnet group id | 86 | 87 | -------------------------------------------------------------------------------- /tests/output/generate/default/TEST-0.2.0.md: -------------------------------------------------------------------------------- 1 | 2 | ## Inputs 3 | 4 | | Name | Description | Type | Default | Required | 5 | |------|-------------|:----:|:-----:|:-----:| 6 | | allocated_storage | The allocated storage in gigabytes | string | - | yes | 7 | | allow_major_version_upgrade | Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible | string | `false` | no | 8 | | apply_immediately | Specifies whether any database modifications are applied immediately, or during the next maintenance window | string | `false` | no | 9 | | auto_minor_version_upgrade | Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window | string | `true` | no | 10 | | availability_zone | The Availability Zone of the RDS instance | string | `` | no | 11 | | backup_retention_period | The days to retain backups for | string | `7` | no | 12 | | backup_window | The daily time range (in UTC) during which automated backups are created if they are enabled. Example: '09:46-10:16'. Must not overlap with maintenance_window | string | - | yes | 13 | | character_set_name | (Optional) The character set name to use for DB encoding in Oracle instances. This can't be changed. See Oracle Character Sets Supported in Amazon RDS for more information | string | `` | no | 14 | | copy_tags_to_snapshot | On delete, copy all Instance tags to the final snapshot (if final_snapshot_identifier is specified) | string | `false` | no | 15 | | create_db_instance | Whether to create a database instance | string | `true` | no | 16 | | create_db_option_group | Whether to create a database option group | string | `true` | no | 17 | | create_db_parameter_group | Whether to create a database parameter group | string | `true` | no | 18 | | create_db_subnet_group | Whether to create a database subnet group | string | `true` | no | 19 | | create_monitoring_role | Create IAM role with a defined name that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. | string | `false` | no | 20 | | db_subnet_group_name | Name of DB subnet group. DB instance will be created in the VPC associated with the DB subnet group. If unspecified, will be created in the default VPC | string | `` | no | 21 | | deletion_protection | The database can't be deleted when this value is set to true. | string | `false` | no | 22 | | enabled_cloudwatch_logs_exports | List of log types to enable for exporting to CloudWatch logs. If omitted, no logs will be exported. Valid values (depending on engine): alert, audit, error, general, listener, slowquery, trace, postgresql (PostgreSQL), upgrade (PostgreSQL). | string | `` | no | 23 | | engine | The database engine to use | string | - | yes | 24 | | engine_version | The engine version to use | string | - | yes | 25 | | family | The family of the DB parameter group | string | `` | no | 26 | | final_snapshot_identifier | The name of your final DB snapshot when this DB instance is deleted. | string | `false` | no | 27 | | iam_database_authentication_enabled | Specifies whether or mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled | string | `false` | no | 28 | | identifier | The name of the RDS instance, if omitted, Terraform will assign a random, unique identifier | string | - | yes | 29 | | instance_class | The instance type of the RDS instance | string | - | yes | 30 | | iops | The amount of provisioned IOPS. Setting this implies a storage_type of 'io1' | string | `0` | no | 31 | | kms_key_id | The ARN for the KMS encryption key. If creating an encrypted replica, set this to the destination KMS ARN. If storage_encrypted is set to true and kms_key_id is not specified the default KMS key created in your account will be used | string | `` | no | 32 | | license_model | License model information for this DB instance. Optional, but required for some DB engines, i.e. Oracle SE1 | string | `` | no | 33 | | maintenance_window | The window to perform maintenance in. Syntax: 'ddd:hh24:mi-ddd:hh24:mi'. Eg: 'Mon:00:00-Mon:03:00' | string | - | yes | 34 | | major_engine_version | Specifies the major version of the engine that this option group should be associated with | string | `` | no | 35 | | monitoring_interval | The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. Valid Values: 0, 1, 5, 10, 15, 30, 60. | string | `0` | no | 36 | | monitoring_role_arn | The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. Must be specified if monitoring_interval is non-zero. | string | `` | no | 37 | | monitoring_role_name | Name of the IAM role which will be created when create_monitoring_role is enabled. | string | `rds-monitoring-role` | no | 38 | | multi_az | Specifies if the RDS instance is multi-AZ | string | `false` | no | 39 | | name | The DB schema name to create. If omitted, no database is created initially | string | `` | no | 40 | | option_group_description | The description of the option group | string | `` | no | 41 | | option_group_name | Name of the DB option group to associate. Setting this automatically disables option_group creation | string | `` | no | 42 | | options | A list of Options to apply. | list | `` | no | 43 | | parameter_group_description | Description of the DB parameter group to create | string | `` | no | 44 | | parameter_group_name | Name of the DB parameter group to associate or create | string | `` | no | 45 | | parameters | A list of DB parameters (map) to apply | string | `` | no | 46 | | password | Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file | string | - | yes | 47 | | port | The port on which the DB accepts connections | string | - | yes | 48 | | publicly_accessible | Bool to control if instance is publicly accessible | string | `false` | no | 49 | | replicate_source_db | Specifies that this resource is a Replicate database, and to use this value as the source database. This correlates to the identifier of another Amazon RDS Database to replicate. | string | `` | no | 50 | | skip_final_snapshot | Determines whether a final DB snapshot is created before the DB instance is deleted. If true is specified, no DBSnapshot is created. If false is specified, a DB snapshot is created before the DB instance is deleted, using the value from final_snapshot_identifier | string | `false` | no | 51 | | snapshot_identifier | Specifies whether or not to create this database from a snapshot. This correlates to the snapshot ID you'd find in the RDS console, e.g: rds:production-2015-06-26-06-05. | string | `` | no | 52 | | storage_encrypted | Specifies whether the DB instance is encrypted | string | `false` | no | 53 | | storage_type | One of 'standard' (magnetic), 'gp2' (general purpose SSD), or 'io1' (provisioned IOPS SSD). The default is 'io1' if iops is specified, 'standard' if not. Note that this behaviour is different from the AWS web console, where the default is 'gp2'. | string | `gp2` | no | 54 | | subnet_ids | A list of VPC subnet IDs | list | `` | no | 55 | | tags | A mapping of tags to assign to all resources | string | `` | no | 56 | | timeouts | (Optional) Updated Terraform resource management timeouts. Applies to `aws_db_instance` in particular to permit resource management times | map | `` | no | 57 | | timezone | (Optional) Time zone of the DB instance. timezone is currently only supported by Microsoft SQL Server. The timezone can only be set on creation. See MSSQL User Guide for more information. | string | `` | no | 58 | | use_option_group_name_prefix | Whether to use the option group name prefix or not | string | `true` | no | 59 | | use_parameter_group_name_prefix | Whether to use the parameter group name prefix or not | string | `true` | no | 60 | | use_subnet_group_name_prefix | Whether to use the subnet group name prefix or not | string | `true` | no | 61 | | username | Username for the master DB user | string | - | yes | 62 | | vpc_security_group_ids | List of VPC security groups to associate | string | `` | no | 63 | 64 | ## Outputs 65 | 66 | | Name | Description | 67 | |------|-------------| 68 | | this_db_instance_address | The address of the RDS instance | 69 | | this_db_instance_arn | The ARN of the RDS instance | 70 | | this_db_instance_availability_zone | The availability zone of the RDS instance | 71 | | this_db_instance_endpoint | The connection endpoint | 72 | | this_db_instance_hosted_zone_id | The canonical hosted zone ID of the DB instance (to be used in a Route 53 Alias record) | 73 | | this_db_instance_id | The RDS instance ID | 74 | | this_db_instance_name | The database name | 75 | | this_db_instance_password | The database password (this password may be old, because Terraform doesn't track it after initial creation) | 76 | | this_db_instance_port | The database port | 77 | | this_db_instance_resource_id | The RDS Resource ID of this instance | 78 | | this_db_instance_status | The RDS instance status | 79 | | this_db_instance_username | The master username for the database | 80 | | this_db_option_group_arn | The ARN of the db option group | 81 | | this_db_option_group_id | The db option group id | 82 | | this_db_parameter_group_arn | The ARN of the db parameter group | 83 | | this_db_parameter_group_id | -------------------------------------------------------------------------------------------------- RDS Parameter group -------------------------------------------------------------------------------------------------- | 84 | | this_db_subnet_group_arn | The ARN of the db subnet group | 85 | | this_db_subnet_group_id | The db subnet group id | 86 | 87 | -------------------------------------------------------------------------------- /tests/output/generate/default/TEST-0.3.0.md: -------------------------------------------------------------------------------- 1 | 2 | ## Inputs 3 | 4 | | Name | Description | Type | Default | Required | 5 | |------|-------------|:----:|:-----:|:-----:| 6 | | allocated_storage | The allocated storage in gigabytes | string | - | yes | 7 | | allow_major_version_upgrade | Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible | string | `false` | no | 8 | | apply_immediately | Specifies whether any database modifications are applied immediately, or during the next maintenance window | string | `false` | no | 9 | | auto_minor_version_upgrade | Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window | string | `true` | no | 10 | | availability_zone | The Availability Zone of the RDS instance | string | `` | no | 11 | | backup_retention_period | The days to retain backups for | string | `7` | no | 12 | | backup_window | The daily time range (in UTC) during which automated backups are created if they are enabled. Example: '09:46-10:16'. Must not overlap with maintenance_window | string | - | yes | 13 | | character_set_name | (Optional) The character set name to use for DB encoding in Oracle instances. This can't be changed. See Oracle Character Sets Supported in Amazon RDS for more information | string | `` | no | 14 | | copy_tags_to_snapshot | On delete, copy all Instance tags to the final snapshot (if final_snapshot_identifier is specified) | string | `false` | no | 15 | | create_db_instance | Whether to create a database instance | string | `true` | no | 16 | | create_db_option_group | Whether to create a database option group | string | `true` | no | 17 | | create_db_parameter_group | Whether to create a database parameter group | string | `true` | no | 18 | | create_db_subnet_group | Whether to create a database subnet group | string | `true` | no | 19 | | create_monitoring_role | Create IAM role with a defined name that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. | string | `false` | no | 20 | | db_subnet_group_name | Name of DB subnet group. DB instance will be created in the VPC associated with the DB subnet group. If unspecified, will be created in the default VPC | string | `` | no | 21 | | deletion_protection | The database can't be deleted when this value is set to true. | string | `false` | no | 22 | | enabled_cloudwatch_logs_exports | List of log types to enable for exporting to CloudWatch logs. If omitted, no logs will be exported. Valid values (depending on engine): alert, audit, error, general, listener, slowquery, trace, postgresql (PostgreSQL), upgrade (PostgreSQL). | string | `` | no | 23 | | engine | The database engine to use | string | - | yes | 24 | | engine_version | The engine version to use | string | - | yes | 25 | | family | The family of the DB parameter group | string | `` | no | 26 | | final_snapshot_identifier | The name of your final DB snapshot when this DB instance is deleted. | string | `false` | no | 27 | | iam_database_authentication_enabled | Specifies whether or mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled | string | `false` | no | 28 | | identifier | The name of the RDS instance, if omitted, Terraform will assign a random, unique identifier | string | - | yes | 29 | | instance_class | The instance type of the RDS instance | string | - | yes | 30 | | iops | The amount of provisioned IOPS. Setting this implies a storage_type of 'io1' | string | `0` | no | 31 | | kms_key_id | The ARN for the KMS encryption key. If creating an encrypted replica, set this to the destination KMS ARN. If storage_encrypted is set to true and kms_key_id is not specified the default KMS key created in your account will be used | string | `` | no | 32 | | license_model | License model information for this DB instance. Optional, but required for some DB engines, i.e. Oracle SE1 | string | `` | no | 33 | | maintenance_window | The window to perform maintenance in. Syntax: 'ddd:hh24:mi-ddd:hh24:mi'. Eg: 'Mon:00:00-Mon:03:00' | string | - | yes | 34 | | major_engine_version | Specifies the major version of the engine that this option group should be associated with | string | `` | no | 35 | | monitoring_interval | The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. Valid Values: 0, 1, 5, 10, 15, 30, 60. | string | `0` | no | 36 | | monitoring_role_arn | The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. Must be specified if monitoring_interval is non-zero. | string | `` | no | 37 | | monitoring_role_name | Name of the IAM role which will be created when create_monitoring_role is enabled. | string | `rds-monitoring-role` | no | 38 | | multi_az | Specifies if the RDS instance is multi-AZ | string | `false` | no | 39 | | name | The DB schema name to create. If omitted, no database is created initially | string | `` | no | 40 | | option_group_description | The description of the option group | string | `` | no | 41 | | option_group_name | Name of the DB option group to associate. Setting this automatically disables option_group creation | string | `` | no | 42 | | options | A list of Options to apply. | list | `` | no | 43 | | parameter_group_description | Description of the DB parameter group to create | string | `` | no | 44 | | parameter_group_name | Name of the DB parameter group to associate or create | string | `` | no | 45 | | parameters | A list of DB parameters (map) to apply | string | `` | no | 46 | | password | Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file | string | - | yes | 47 | | port | The port on which the DB accepts connections | string | - | yes | 48 | | publicly_accessible | Bool to control if instance is publicly accessible | string | `false` | no | 49 | | replicate_source_db | Specifies that this resource is a Replicate database, and to use this value as the source database. This correlates to the identifier of another Amazon RDS Database to replicate. | string | `` | no | 50 | | skip_final_snapshot | Determines whether a final DB snapshot is created before the DB instance is deleted. If true is specified, no DBSnapshot is created. If false is specified, a DB snapshot is created before the DB instance is deleted, using the value from final_snapshot_identifier | string | `false` | no | 51 | | snapshot_identifier | Specifies whether or not to create this database from a snapshot. This correlates to the snapshot ID you'd find in the RDS console, e.g: rds:production-2015-06-26-06-05. | string | `` | no | 52 | | storage_encrypted | Specifies whether the DB instance is encrypted | string | `false` | no | 53 | | storage_type | One of 'standard' (magnetic), 'gp2' (general purpose SSD), or 'io1' (provisioned IOPS SSD). The default is 'io1' if iops is specified, 'standard' if not. Note that this behaviour is different from the AWS web console, where the default is 'gp2'. | string | `gp2` | no | 54 | | subnet_ids | A list of VPC subnet IDs | list | `` | no | 55 | | tags | A mapping of tags to assign to all resources | string | `` | no | 56 | | timeouts | (Optional) Updated Terraform resource management timeouts. Applies to `aws_db_instance` in particular to permit resource management times | map | `` | no | 57 | | timezone | (Optional) Time zone of the DB instance. timezone is currently only supported by Microsoft SQL Server. The timezone can only be set on creation. See MSSQL User Guide for more information. | string | `` | no | 58 | | use_option_group_name_prefix | Whether to use the option group name prefix or not | string | `true` | no | 59 | | use_parameter_group_name_prefix | Whether to use the parameter group name prefix or not | string | `true` | no | 60 | | use_subnet_group_name_prefix | Whether to use the subnet group name prefix or not | string | `true` | no | 61 | | username | Username for the master DB user | string | - | yes | 62 | | vpc_security_group_ids | List of VPC security groups to associate | string | `` | no | 63 | 64 | ## Outputs 65 | 66 | | Name | Description | 67 | |------|-------------| 68 | | this_db_instance_address | The address of the RDS instance | 69 | | this_db_instance_arn | The ARN of the RDS instance | 70 | | this_db_instance_availability_zone | The availability zone of the RDS instance | 71 | | this_db_instance_endpoint | The connection endpoint | 72 | | this_db_instance_hosted_zone_id | The canonical hosted zone ID of the DB instance (to be used in a Route 53 Alias record) | 73 | | this_db_instance_id | The RDS instance ID | 74 | | this_db_instance_name | The database name | 75 | | this_db_instance_password | The database password (this password may be old, because Terraform doesn't track it after initial creation) | 76 | | this_db_instance_port | The database port | 77 | | this_db_instance_resource_id | The RDS Resource ID of this instance | 78 | | this_db_instance_status | The RDS instance status | 79 | | this_db_instance_username | The master username for the database | 80 | | this_db_option_group_arn | The ARN of the db option group | 81 | | this_db_option_group_id | The db option group id | 82 | | this_db_parameter_group_arn | The ARN of the db parameter group | 83 | | this_db_parameter_group_id | -------------------------------------------------------------------------------------------------- RDS Parameter group -------------------------------------------------------------------------------------------------- | 84 | | this_db_subnet_group_arn | The ARN of the db subnet group | 85 | | this_db_subnet_group_id | The db subnet group id | 86 | 87 | -------------------------------------------------------------------------------- /tests/output/replace/default/TEST-0.4.5.md: -------------------------------------------------------------------------------- 1 | # Test 2 | 3 | Stuff before terraform-docs 4 | 5 | 6 | ## Inputs 7 | 8 | | Name | Description | Type | Default | Required | 9 | |------|-------------|:----:|:-----:|:-----:| 10 | | allocated_storage | The allocated storage in gigabytes | string | - | yes | 11 | | allow_major_version_upgrade | Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible | string | `false` | no | 12 | | apply_immediately | Specifies whether any database modifications are applied immediately, or during the next maintenance window | string | `false` | no | 13 | | auto_minor_version_upgrade | Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window | string | `true` | no | 14 | | availability_zone | The Availability Zone of the RDS instance | string | `` | no | 15 | | backup_retention_period | The days to retain backups for | string | `7` | no | 16 | | backup_window | The daily time range (in UTC) during which automated backups are created if they are enabled. Example: '09:46-10:16'. Must not overlap with maintenance_window | string | - | yes | 17 | | character_set_name | (Optional) The character set name to use for DB encoding in Oracle instances. This can't be changed. See Oracle Character Sets Supported in Amazon RDS for more information | string | `` | no | 18 | | copy_tags_to_snapshot | On delete, copy all Instance tags to the final snapshot (if final_snapshot_identifier is specified) | string | `false` | no | 19 | | create_db_instance | Whether to create a database instance | string | `true` | no | 20 | | create_db_option_group | Whether to create a database option group | string | `true` | no | 21 | | create_db_parameter_group | Whether to create a database parameter group | string | `true` | no | 22 | | create_db_subnet_group | Whether to create a database subnet group | string | `true` | no | 23 | | create_monitoring_role | Create IAM role with a defined name that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. | string | `false` | no | 24 | | db_subnet_group_name | Name of DB subnet group. DB instance will be created in the VPC associated with the DB subnet group. If unspecified, will be created in the default VPC | string | `` | no | 25 | | deletion_protection | The database can't be deleted when this value is set to true. | string | `false` | no | 26 | | enabled_cloudwatch_logs_exports | List of log types to enable for exporting to CloudWatch logs. If omitted, no logs will be exported. Valid values (depending on engine): alert, audit, error, general, listener, slowquery, trace, postgresql (PostgreSQL), upgrade (PostgreSQL). | list | `[]` | no | 27 | | engine | The database engine to use | string | - | yes | 28 | | engine_version | The engine version to use | string | - | yes | 29 | | family | The family of the DB parameter group | string | `` | no | 30 | | final_snapshot_identifier | The name of your final DB snapshot when this DB instance is deleted. | string | `false` | no | 31 | | iam_database_authentication_enabled | Specifies whether or mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled | string | `false` | no | 32 | | identifier | The name of the RDS instance, if omitted, Terraform will assign a random, unique identifier | string | - | yes | 33 | | instance_class | The instance type of the RDS instance | string | - | yes | 34 | | iops | The amount of provisioned IOPS. Setting this implies a storage_type of 'io1' | string | `0` | no | 35 | | kms_key_id | The ARN for the KMS encryption key. If creating an encrypted replica, set this to the destination KMS ARN. If storage_encrypted is set to true and kms_key_id is not specified the default KMS key created in your account will be used | string | `` | no | 36 | | license_model | License model information for this DB instance. Optional, but required for some DB engines, i.e. Oracle SE1 | string | `` | no | 37 | | maintenance_window | The window to perform maintenance in. Syntax: 'ddd:hh24:mi-ddd:hh24:mi'. Eg: 'Mon:00:00-Mon:03:00' | string | - | yes | 38 | | major_engine_version | Specifies the major version of the engine that this option group should be associated with | string | `` | no | 39 | | monitoring_interval | The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. Valid Values: 0, 1, 5, 10, 15, 30, 60. | string | `0` | no | 40 | | monitoring_role_arn | The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. Must be specified if monitoring_interval is non-zero. | string | `` | no | 41 | | monitoring_role_name | Name of the IAM role which will be created when create_monitoring_role is enabled. | string | `rds-monitoring-role` | no | 42 | | multi_az | Specifies if the RDS instance is multi-AZ | string | `false` | no | 43 | | name | The DB schema name to create. If omitted, no database is created initially | string | `` | no | 44 | | option_group_description | The description of the option group | string | `` | no | 45 | | option_group_name | Name of the DB option group to associate. Setting this automatically disables option_group creation | string | `` | no | 46 | | options | A list of Options to apply. | list | `[]` | no | 47 | | parameter_group_description | Description of the DB parameter group to create | string | `` | no | 48 | | parameter_group_name | Name of the DB parameter group to associate or create | string | `` | no | 49 | | parameters | A list of DB parameters (map) to apply | list | `[]` | no | 50 | | password | Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file | string | - | yes | 51 | | port | The port on which the DB accepts connections | string | - | yes | 52 | | publicly_accessible | Bool to control if instance is publicly accessible | string | `false` | no | 53 | | replicate_source_db | Specifies that this resource is a Replicate database, and to use this value as the source database. This correlates to the identifier of another Amazon RDS Database to replicate. | string | `` | no | 54 | | skip_final_snapshot | Determines whether a final DB snapshot is created before the DB instance is deleted. If true is specified, no DBSnapshot is created. If false is specified, a DB snapshot is created before the DB instance is deleted, using the value from final_snapshot_identifier | string | `false` | no | 55 | | snapshot_identifier | Specifies whether or not to create this database from a snapshot. This correlates to the snapshot ID you'd find in the RDS console, e.g: rds:production-2015-06-26-06-05. | string | `` | no | 56 | | storage_encrypted | Specifies whether the DB instance is encrypted | string | `false` | no | 57 | | storage_type | One of 'standard' (magnetic), 'gp2' (general purpose SSD), or 'io1' (provisioned IOPS SSD). The default is 'io1' if iops is specified, 'standard' if not. Note that this behaviour is different from the AWS web console, where the default is 'gp2'. | string | `gp2` | no | 58 | | subnet_ids | A list of VPC subnet IDs | list | `[]` | no | 59 | | tags | A mapping of tags to assign to all resources | map | `{}` | no | 60 | | timeouts | (Optional) Updated Terraform resource management timeouts. Applies to `aws_db_instance` in particular to permit resource management times | map | `{ "create": "40m", "delete": "40m", "update": "80m" }` | no | 61 | | timezone | (Optional) Time zone of the DB instance. timezone is currently only supported by Microsoft SQL Server. The timezone can only be set on creation. See MSSQL User Guide for more information. | string | `` | no | 62 | | use_option_group_name_prefix | Whether to use the option group name prefix or not | string | `true` | no | 63 | | use_parameter_group_name_prefix | Whether to use the parameter group name prefix or not | string | `true` | no | 64 | | use_subnet_group_name_prefix | Whether to use the subnet group name prefix or not | string | `true` | no | 65 | | username | Username for the master DB user | string | - | yes | 66 | | vpc_security_group_ids | List of VPC security groups to associate | list | `[]` | no | 67 | 68 | ## Outputs 69 | 70 | | Name | Description | 71 | |------|-------------| 72 | | this_db_instance_address | The address of the RDS instance | 73 | | this_db_instance_arn | The ARN of the RDS instance | 74 | | this_db_instance_availability_zone | The availability zone of the RDS instance | 75 | | this_db_instance_endpoint | The connection endpoint | 76 | | this_db_instance_hosted_zone_id | The canonical hosted zone ID of the DB instance (to be used in a Route 53 Alias record) | 77 | | this_db_instance_id | The RDS instance ID | 78 | | this_db_instance_name | The database name | 79 | | this_db_instance_password | The database password (this password may be old, because Terraform doesn't track it after initial creation) | 80 | | this_db_instance_port | The database port | 81 | | this_db_instance_resource_id | The RDS Resource ID of this instance | 82 | | this_db_instance_status | The RDS instance status | 83 | | this_db_instance_username | The master username for the database | 84 | | this_db_option_group_arn | The ARN of the db option group | 85 | | this_db_option_group_id | The db option group id | 86 | | this_db_parameter_group_arn | The ARN of the db parameter group | 87 | | this_db_parameter_group_id | The db parameter group id | 88 | | this_db_subnet_group_arn | The ARN of the db subnet group | 89 | | this_db_subnet_group_id | The db subnet group id | 90 | 91 | 92 | 93 | Stuff after terraform-docs 94 | -------------------------------------------------------------------------------- /tests/output/replace/default/TEST-0.4.0.md: -------------------------------------------------------------------------------- 1 | # Test 2 | 3 | Stuff before terraform-docs 4 | 5 | 6 | 7 | ## Inputs 8 | 9 | | Name | Description | Type | Default | Required | 10 | |------|-------------|:----:|:-----:|:-----:| 11 | | allocated_storage | The allocated storage in gigabytes | string | - | yes | 12 | | allow_major_version_upgrade | Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible | string | `false` | no | 13 | | apply_immediately | Specifies whether any database modifications are applied immediately, or during the next maintenance window | string | `false` | no | 14 | | auto_minor_version_upgrade | Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window | string | `true` | no | 15 | | availability_zone | The Availability Zone of the RDS instance | string | `` | no | 16 | | backup_retention_period | The days to retain backups for | string | `7` | no | 17 | | backup_window | The daily time range (in UTC) during which automated backups are created if they are enabled. Example: '09:46-10:16'. Must not overlap with maintenance_window | string | - | yes | 18 | | character_set_name | (Optional) The character set name to use for DB encoding in Oracle instances. This can't be changed. See Oracle Character Sets Supported in Amazon RDS for more information | string | `` | no | 19 | | copy_tags_to_snapshot | On delete, copy all Instance tags to the final snapshot (if final_snapshot_identifier is specified) | string | `false` | no | 20 | | create_db_instance | Whether to create a database instance | string | `true` | no | 21 | | create_db_option_group | Whether to create a database option group | string | `true` | no | 22 | | create_db_parameter_group | Whether to create a database parameter group | string | `true` | no | 23 | | create_db_subnet_group | Whether to create a database subnet group | string | `true` | no | 24 | | create_monitoring_role | Create IAM role with a defined name that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. | string | `false` | no | 25 | | db_subnet_group_name | Name of DB subnet group. DB instance will be created in the VPC associated with the DB subnet group. If unspecified, will be created in the default VPC | string | `` | no | 26 | | deletion_protection | The database can't be deleted when this value is set to true. | string | `false` | no | 27 | | enabled_cloudwatch_logs_exports | List of log types to enable for exporting to CloudWatch logs. If omitted, no logs will be exported. Valid values (depending on engine): alert, audit, error, general, listener, slowquery, trace, postgresql (PostgreSQL), upgrade (PostgreSQL). | list | `[]` | no | 28 | | engine | The database engine to use | string | - | yes | 29 | | engine_version | The engine version to use | string | - | yes | 30 | | family | The family of the DB parameter group | string | `` | no | 31 | | final_snapshot_identifier | The name of your final DB snapshot when this DB instance is deleted. | string | `false` | no | 32 | | iam_database_authentication_enabled | Specifies whether or mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled | string | `false` | no | 33 | | identifier | The name of the RDS instance, if omitted, Terraform will assign a random, unique identifier | string | - | yes | 34 | | instance_class | The instance type of the RDS instance | string | - | yes | 35 | | iops | The amount of provisioned IOPS. Setting this implies a storage_type of 'io1' | string | `0` | no | 36 | | kms_key_id | The ARN for the KMS encryption key. If creating an encrypted replica, set this to the destination KMS ARN. If storage_encrypted is set to true and kms_key_id is not specified the default KMS key created in your account will be used | string | `` | no | 37 | | license_model | License model information for this DB instance. Optional, but required for some DB engines, i.e. Oracle SE1 | string | `` | no | 38 | | maintenance_window | The window to perform maintenance in. Syntax: 'ddd:hh24:mi-ddd:hh24:mi'. Eg: 'Mon:00:00-Mon:03:00' | string | - | yes | 39 | | major_engine_version | Specifies the major version of the engine that this option group should be associated with | string | `` | no | 40 | | monitoring_interval | The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. Valid Values: 0, 1, 5, 10, 15, 30, 60. | string | `0` | no | 41 | | monitoring_role_arn | The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. Must be specified if monitoring_interval is non-zero. | string | `` | no | 42 | | monitoring_role_name | Name of the IAM role which will be created when create_monitoring_role is enabled. | string | `rds-monitoring-role` | no | 43 | | multi_az | Specifies if the RDS instance is multi-AZ | string | `false` | no | 44 | | name | The DB schema name to create. If omitted, no database is created initially | string | `` | no | 45 | | option_group_description | The description of the option group | string | `` | no | 46 | | option_group_name | Name of the DB option group to associate. Setting this automatically disables option_group creation | string | `` | no | 47 | | options | A list of Options to apply. | list | `[]` | no | 48 | | parameter_group_description | Description of the DB parameter group to create | string | `` | no | 49 | | parameter_group_name | Name of the DB parameter group to associate or create | string | `` | no | 50 | | parameters | A list of DB parameters (map) to apply | list | `[]` | no | 51 | | password | Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file | string | - | yes | 52 | | port | The port on which the DB accepts connections | string | - | yes | 53 | | publicly_accessible | Bool to control if instance is publicly accessible | string | `false` | no | 54 | | replicate_source_db | Specifies that this resource is a Replicate database, and to use this value as the source database. This correlates to the identifier of another Amazon RDS Database to replicate. | string | `` | no | 55 | | skip_final_snapshot | Determines whether a final DB snapshot is created before the DB instance is deleted. If true is specified, no DBSnapshot is created. If false is specified, a DB snapshot is created before the DB instance is deleted, using the value from final_snapshot_identifier | string | `false` | no | 56 | | snapshot_identifier | Specifies whether or not to create this database from a snapshot. This correlates to the snapshot ID you'd find in the RDS console, e.g: rds:production-2015-06-26-06-05. | string | `` | no | 57 | | storage_encrypted | Specifies whether the DB instance is encrypted | string | `false` | no | 58 | | storage_type | One of 'standard' (magnetic), 'gp2' (general purpose SSD), or 'io1' (provisioned IOPS SSD). The default is 'io1' if iops is specified, 'standard' if not. Note that this behaviour is different from the AWS web console, where the default is 'gp2'. | string | `gp2` | no | 59 | | subnet_ids | A list of VPC subnet IDs | list | `[]` | no | 60 | | tags | A mapping of tags to assign to all resources | map | `{}` | no | 61 | | timeouts | (Optional) Updated Terraform resource management timeouts. Applies to `aws_db_instance` in particular to permit resource management times | map | `{ "create": "40m", "delete": "40m", "update": "80m" }` | no | 62 | | timezone | (Optional) Time zone of the DB instance. timezone is currently only supported by Microsoft SQL Server. The timezone can only be set on creation. See MSSQL User Guide for more information. | string | `` | no | 63 | | use_option_group_name_prefix | Whether to use the option group name prefix or not | string | `true` | no | 64 | | use_parameter_group_name_prefix | Whether to use the parameter group name prefix or not | string | `true` | no | 65 | | use_subnet_group_name_prefix | Whether to use the subnet group name prefix or not | string | `true` | no | 66 | | username | Username for the master DB user | string | - | yes | 67 | | vpc_security_group_ids | List of VPC security groups to associate | list | `[]` | no | 68 | 69 | ## Outputs 70 | 71 | | Name | Description | 72 | |------|-------------| 73 | | this_db_instance_address | The address of the RDS instance | 74 | | this_db_instance_arn | The ARN of the RDS instance | 75 | | this_db_instance_availability_zone | The availability zone of the RDS instance | 76 | | this_db_instance_endpoint | The connection endpoint | 77 | | this_db_instance_hosted_zone_id | The canonical hosted zone ID of the DB instance (to be used in a Route 53 Alias record) | 78 | | this_db_instance_id | The RDS instance ID | 79 | | this_db_instance_name | The database name | 80 | | this_db_instance_password | The database password (this password may be old, because Terraform doesn't track it after initial creation) | 81 | | this_db_instance_port | The database port | 82 | | this_db_instance_resource_id | The RDS Resource ID of this instance | 83 | | this_db_instance_status | The RDS instance status | 84 | | this_db_instance_username | The master username for the database | 85 | | this_db_option_group_arn | The ARN of the db option group | 86 | | this_db_option_group_id | The db option group id | 87 | | this_db_parameter_group_arn | The ARN of the db parameter group | 88 | | this_db_parameter_group_id | The db parameter group id | 89 | | this_db_subnet_group_arn | The ARN of the db subnet group | 90 | | this_db_subnet_group_id | The db subnet group id | 91 | 92 | 93 | 94 | Stuff after terraform-docs 95 | -------------------------------------------------------------------------------- /tests/output/generate/default/TEST-0.6.0.md: -------------------------------------------------------------------------------- 1 | ## Inputs 2 | 3 | | Name | Description | Type | Default | Required | 4 | |------|-------------|:----:|:-----:|:-----:| 5 | | allocated\_storage | The allocated storage in gigabytes | string | n/a | yes | 6 | | backup\_window | The daily time range (in UTC) during which automated backups are created if they are enabled. Example: '09:46-10:16'. Must not overlap with maintenance_window | string | n/a | yes | 7 | | engine | The database engine to use | string | n/a | yes | 8 | | engine\_version | The engine version to use | string | n/a | yes | 9 | | identifier | The name of the RDS instance, if omitted, Terraform will assign a random, unique identifier | string | n/a | yes | 10 | | instance\_class | The instance type of the RDS instance | string | n/a | yes | 11 | | maintenance\_window | The window to perform maintenance in. Syntax: 'ddd:hh24:mi-ddd:hh24:mi'. Eg: 'Mon:00:00-Mon:03:00' | string | n/a | yes | 12 | | password | Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file | string | n/a | yes | 13 | | port | The port on which the DB accepts connections | string | n/a | yes | 14 | | username | Username for the master DB user | string | n/a | yes | 15 | | allow\_major\_version\_upgrade | Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible | string | `"false"` | no | 16 | | apply\_immediately | Specifies whether any database modifications are applied immediately, or during the next maintenance window | string | `"false"` | no | 17 | | auto\_minor\_version\_upgrade | Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window | string | `"true"` | no | 18 | | availability\_zone | The Availability Zone of the RDS instance | string | `""` | no | 19 | | backup\_retention\_period | The days to retain backups for | string | `"7"` | no | 20 | | character\_set\_name | (Optional) The character set name to use for DB encoding in Oracle instances. This can't be changed. See Oracle Character Sets Supported in Amazon RDS for more information | string | `""` | no | 21 | | copy\_tags\_to\_snapshot | On delete, copy all Instance tags to the final snapshot (if final_snapshot_identifier is specified) | string | `"false"` | no | 22 | | create\_db\_instance | Whether to create a database instance | string | `"true"` | no | 23 | | create\_db\_option\_group | Whether to create a database option group | string | `"true"` | no | 24 | | create\_db\_parameter\_group | Whether to create a database parameter group | string | `"true"` | no | 25 | | create\_db\_subnet\_group | Whether to create a database subnet group | string | `"true"` | no | 26 | | create\_monitoring\_role | Create IAM role with a defined name that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. | string | `"false"` | no | 27 | | db\_subnet\_group\_name | Name of DB subnet group. DB instance will be created in the VPC associated with the DB subnet group. If unspecified, will be created in the default VPC | string | `""` | no | 28 | | deletion\_protection | The database can't be deleted when this value is set to true. | string | `"false"` | no | 29 | | enabled\_cloudwatch\_logs\_exports | List of log types to enable for exporting to CloudWatch logs. If omitted, no logs will be exported. Valid values (depending on engine): alert, audit, error, general, listener, slowquery, trace, postgresql (PostgreSQL), upgrade (PostgreSQL). | list | `[]` | no | 30 | | family | The family of the DB parameter group | string | `""` | no | 31 | | final\_snapshot\_identifier | The name of your final DB snapshot when this DB instance is deleted. | string | `"false"` | no | 32 | | iam\_database\_authentication\_enabled | Specifies whether or mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled | string | `"false"` | no | 33 | | iops | The amount of provisioned IOPS. Setting this implies a storage_type of 'io1' | string | `"0"` | no | 34 | | kms\_key\_id | The ARN for the KMS encryption key. If creating an encrypted replica, set this to the destination KMS ARN. If storage_encrypted is set to true and kms_key_id is not specified the default KMS key created in your account will be used | string | `""` | no | 35 | | license\_model | License model information for this DB instance. Optional, but required for some DB engines, i.e. Oracle SE1 | string | `""` | no | 36 | | major\_engine\_version | Specifies the major version of the engine that this option group should be associated with | string | `""` | no | 37 | | monitoring\_interval | The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. Valid Values: 0, 1, 5, 10, 15, 30, 60. | string | `"0"` | no | 38 | | monitoring\_role\_arn | The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. Must be specified if monitoring_interval is non-zero. | string | `""` | no | 39 | | monitoring\_role\_name | Name of the IAM role which will be created when create_monitoring_role is enabled. | string | `"rds-monitoring-role"` | no | 40 | | multi\_az | Specifies if the RDS instance is multi-AZ | string | `"false"` | no | 41 | | name | The DB schema name to create. If omitted, no database is created initially | string | `""` | no | 42 | | option\_group\_description | The description of the option group | string | `""` | no | 43 | | option\_group\_name | Name of the DB option group to associate. Setting this automatically disables option_group creation | string | `""` | no | 44 | | options | A list of Options to apply. | list | `[]` | no | 45 | | parameter\_group\_description | Description of the DB parameter group to create | string | `""` | no | 46 | | parameter\_group\_name | Name of the DB parameter group to associate or create | string | `""` | no | 47 | | parameters | A list of DB parameters (map) to apply | list | `[]` | no | 48 | | publicly\_accessible | Bool to control if instance is publicly accessible | string | `"false"` | no | 49 | | replicate\_source\_db | Specifies that this resource is a Replicate database, and to use this value as the source database. This correlates to the identifier of another Amazon RDS Database to replicate. | string | `""` | no | 50 | | skip\_final\_snapshot | Determines whether a final DB snapshot is created before the DB instance is deleted. If true is specified, no DBSnapshot is created. If false is specified, a DB snapshot is created before the DB instance is deleted, using the value from final_snapshot_identifier | string | `"false"` | no | 51 | | snapshot\_identifier | Specifies whether or not to create this database from a snapshot. This correlates to the snapshot ID you'd find in the RDS console, e.g: rds:production-2015-06-26-06-05. | string | `""` | no | 52 | | storage\_encrypted | Specifies whether the DB instance is encrypted | string | `"false"` | no | 53 | | storage\_type | One of 'standard' (magnetic), 'gp2' (general purpose SSD), or 'io1' (provisioned IOPS SSD). The default is 'io1' if iops is specified, 'standard' if not. Note that this behaviour is different from the AWS web console, where the default is 'gp2'. | string | `"gp2"` | no | 54 | | subnet\_ids | A list of VPC subnet IDs | list | `[]` | no | 55 | | tags | A mapping of tags to assign to all resources | map | `{}` | no | 56 | | timeouts | (Optional) Updated Terraform resource management timeouts. Applies to `aws_db_instance` in particular to permit resource management times | map | `{ "create": "40m", "delete": "40m", "update": "80m" }` | no | 57 | | timezone | (Optional) Time zone of the DB instance. timezone is currently only supported by Microsoft SQL Server. The timezone can only be set on creation. See MSSQL User Guide for more information. | string | `""` | no | 58 | | use\_option\_group\_name\_prefix | Whether to use the option group name prefix or not | string | `"true"` | no | 59 | | use\_parameter\_group\_name\_prefix | Whether to use the parameter group name prefix or not | string | `"true"` | no | 60 | | use\_subnet\_group\_name\_prefix | Whether to use the subnet group name prefix or not | string | `"true"` | no | 61 | | vpc\_security\_group\_ids | List of VPC security groups to associate | list | `[]` | no | 62 | 63 | ## Outputs 64 | 65 | | Name | Description | 66 | |------|-------------| 67 | | this\_db\_instance\_address | The address of the RDS instance | 68 | | this\_db\_instance\_arn | The ARN of the RDS instance | 69 | | this\_db\_instance\_availability\_zone | The availability zone of the RDS instance | 70 | | this\_db\_instance\_endpoint | The connection endpoint | 71 | | this\_db\_instance\_hosted\_zone\_id | The canonical hosted zone ID of the DB instance (to be used in a Route 53 Alias record) | 72 | | this\_db\_instance\_id | The RDS instance ID | 73 | | this\_db\_instance\_name | The database name | 74 | | this\_db\_instance\_password | The database password (this password may be old, because Terraform doesn't track it after initial creation) | 75 | | this\_db\_instance\_port | The database port | 76 | | this\_db\_instance\_resource\_id | The RDS Resource ID of this instance | 77 | | this\_db\_instance\_status | The RDS instance status | 78 | | this\_db\_instance\_username | The master username for the database | 79 | | this\_db\_option\_group\_arn | The ARN of the db option group | 80 | | this\_db\_option\_group\_id | The db option group id | 81 | | this\_db\_parameter\_group\_arn | The ARN of the db parameter group | 82 | | this\_db\_parameter\_group\_id | The db parameter group id | 83 | | this\_db\_subnet\_group\_arn | The ARN of the db subnet group | 84 | | this\_db\_subnet\_group\_id | The db subnet group id | 85 | 86 | -------------------------------------------------------------------------------- /tests/output/generate/default/TEST-0.7.0.md: -------------------------------------------------------------------------------- 1 | ## Inputs 2 | 3 | | Name | Description | Type | Default | Required | 4 | |------|-------------|:----:|:-----:|:-----:| 5 | | allocated\_storage | The allocated storage in gigabytes | string | n/a | yes | 6 | | backup\_window | The daily time range \(in UTC\) during which automated backups are created if they are enabled. Example: '09:46-10:16'. Must not overlap with maintenance\_window | string | n/a | yes | 7 | | engine | The database engine to use | string | n/a | yes | 8 | | engine\_version | The engine version to use | string | n/a | yes | 9 | | identifier | The name of the RDS instance, if omitted, Terraform will assign a random, unique identifier | string | n/a | yes | 10 | | instance\_class | The instance type of the RDS instance | string | n/a | yes | 11 | | maintenance\_window | The window to perform maintenance in. Syntax: 'ddd:hh24:mi-ddd:hh24:mi'. Eg: 'Mon:00:00-Mon:03:00' | string | n/a | yes | 12 | | password | Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file | string | n/a | yes | 13 | | port | The port on which the DB accepts connections | string | n/a | yes | 14 | | username | Username for the master DB user | string | n/a | yes | 15 | | allow\_major\_version\_upgrade | Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible | string | `"false"` | no | 16 | | apply\_immediately | Specifies whether any database modifications are applied immediately, or during the next maintenance window | string | `"false"` | no | 17 | | auto\_minor\_version\_upgrade | Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window | string | `"true"` | no | 18 | | availability\_zone | The Availability Zone of the RDS instance | string | `""` | no | 19 | | backup\_retention\_period | The days to retain backups for | string | `"7"` | no | 20 | | character\_set\_name | \(Optional\) The character set name to use for DB encoding in Oracle instances. This can't be changed. See Oracle Character Sets Supported in Amazon RDS for more information | string | `""` | no | 21 | | copy\_tags\_to\_snapshot | On delete, copy all Instance tags to the final snapshot \(if final\_snapshot\_identifier is specified\) | string | `"false"` | no | 22 | | create\_db\_instance | Whether to create a database instance | string | `"true"` | no | 23 | | create\_db\_option\_group | Whether to create a database option group | string | `"true"` | no | 24 | | create\_db\_parameter\_group | Whether to create a database parameter group | string | `"true"` | no | 25 | | create\_db\_subnet\_group | Whether to create a database subnet group | string | `"true"` | no | 26 | | create\_monitoring\_role | Create IAM role with a defined name that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. | string | `"false"` | no | 27 | | db\_subnet\_group\_name | Name of DB subnet group. DB instance will be created in the VPC associated with the DB subnet group. If unspecified, will be created in the default VPC | string | `""` | no | 28 | | deletion\_protection | The database can't be deleted when this value is set to true. | string | `"false"` | no | 29 | | enabled\_cloudwatch\_logs\_exports | List of log types to enable for exporting to CloudWatch logs. If omitted, no logs will be exported. Valid values \(depending on engine\): alert, audit, error, general, listener, slowquery, trace, postgresql \(PostgreSQL\), upgrade \(PostgreSQL\). | list | `[]` | no | 30 | | family | The family of the DB parameter group | string | `""` | no | 31 | | final\_snapshot\_identifier | The name of your final DB snapshot when this DB instance is deleted. | string | `"false"` | no | 32 | | iam\_database\_authentication\_enabled | Specifies whether or mappings of AWS Identity and Access Management \(IAM\) accounts to database accounts is enabled | string | `"false"` | no | 33 | | iops | The amount of provisioned IOPS. Setting this implies a storage\_type of 'io1' | string | `"0"` | no | 34 | | kms\_key\_id | The ARN for the KMS encryption key. If creating an encrypted replica, set this to the destination KMS ARN. If storage\_encrypted is set to true and kms\_key\_id is not specified the default KMS key created in your account will be used | string | `""` | no | 35 | | license\_model | License model information for this DB instance. Optional, but required for some DB engines, i.e. Oracle SE1 | string | `""` | no | 36 | | major\_engine\_version | Specifies the major version of the engine that this option group should be associated with | string | `""` | no | 37 | | monitoring\_interval | The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. Valid Values: 0, 1, 5, 10, 15, 30, 60. | string | `"0"` | no | 38 | | monitoring\_role\_arn | The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. Must be specified if monitoring\_interval is non-zero. | string | `""` | no | 39 | | monitoring\_role\_name | Name of the IAM role which will be created when create\_monitoring\_role is enabled. | string | `"rds-monitoring-role"` | no | 40 | | multi\_az | Specifies if the RDS instance is multi-AZ | string | `"false"` | no | 41 | | name | The DB schema name to create. If omitted, no database is created initially | string | `""` | no | 42 | | option\_group\_description | The description of the option group | string | `""` | no | 43 | | option\_group\_name | Name of the DB option group to associate. Setting this automatically disables option\_group creation | string | `""` | no | 44 | | options | A list of Options to apply. | list | `[]` | no | 45 | | parameter\_group\_description | Description of the DB parameter group to create | string | `""` | no | 46 | | parameter\_group\_name | Name of the DB parameter group to associate or create | string | `""` | no | 47 | | parameters | A list of DB parameters \(map\) to apply | list | `[]` | no | 48 | | publicly\_accessible | Bool to control if instance is publicly accessible | string | `"false"` | no | 49 | | replicate\_source\_db | Specifies that this resource is a Replicate database, and to use this value as the source database. This correlates to the identifier of another Amazon RDS Database to replicate. | string | `""` | no | 50 | | skip\_final\_snapshot | Determines whether a final DB snapshot is created before the DB instance is deleted. If true is specified, no DBSnapshot is created. If false is specified, a DB snapshot is created before the DB instance is deleted, using the value from final\_snapshot\_identifier | string | `"false"` | no | 51 | | snapshot\_identifier | Specifies whether or not to create this database from a snapshot. This correlates to the snapshot ID you'd find in the RDS console, e.g: rds:production-2015-06-26-06-05. | string | `""` | no | 52 | | storage\_encrypted | Specifies whether the DB instance is encrypted | string | `"false"` | no | 53 | | storage\_type | One of 'standard' \(magnetic\), 'gp2' \(general purpose SSD\), or 'io1' \(provisioned IOPS SSD\). The default is 'io1' if iops is specified, 'standard' if not. Note that this behaviour is different from the AWS web console, where the default is 'gp2'. | string | `"gp2"` | no | 54 | | subnet\_ids | A list of VPC subnet IDs | list | `[]` | no | 55 | | tags | A mapping of tags to assign to all resources | map | `{}` | no | 56 | | timeouts | \(Optional\) Updated Terraform resource management timeouts. Applies to `aws\_db\_instance` in particular to permit resource management times | map | `{ "create": "40m", "delete": "40m", "update": "80m" }` | no | 57 | | timezone | \(Optional\) Time zone of the DB instance. timezone is currently only supported by Microsoft SQL Server. The timezone can only be set on creation. See MSSQL User Guide for more information. | string | `""` | no | 58 | | use\_option\_group\_name\_prefix | Whether to use the option group name prefix or not | string | `"true"` | no | 59 | | use\_parameter\_group\_name\_prefix | Whether to use the parameter group name prefix or not | string | `"true"` | no | 60 | | use\_subnet\_group\_name\_prefix | Whether to use the subnet group name prefix or not | string | `"true"` | no | 61 | | vpc\_security\_group\_ids | List of VPC security groups to associate | list | `[]` | no | 62 | 63 | ## Outputs 64 | 65 | | Name | Description | 66 | |------|-------------| 67 | | this\_db\_instance\_address | The address of the RDS instance | 68 | | this\_db\_instance\_arn | The ARN of the RDS instance | 69 | | this\_db\_instance\_availability\_zone | The availability zone of the RDS instance | 70 | | this\_db\_instance\_endpoint | The connection endpoint | 71 | | this\_db\_instance\_hosted\_zone\_id | The canonical hosted zone ID of the DB instance \(to be used in a Route 53 Alias record\) | 72 | | this\_db\_instance\_id | The RDS instance ID | 73 | | this\_db\_instance\_name | The database name | 74 | | this\_db\_instance\_password | The database password \(this password may be old, because Terraform doesn't track it after initial creation\) | 75 | | this\_db\_instance\_port | The database port | 76 | | this\_db\_instance\_resource\_id | The RDS Resource ID of this instance | 77 | | this\_db\_instance\_status | The RDS instance status | 78 | | this\_db\_instance\_username | The master username for the database | 79 | | this\_db\_option\_group\_arn | The ARN of the db option group | 80 | | this\_db\_option\_group\_id | The db option group id | 81 | | this\_db\_parameter\_group\_arn | The ARN of the db parameter group | 82 | | this\_db\_parameter\_group\_id | The db parameter group id | 83 | | this\_db\_subnet\_group\_arn | The ARN of the db subnet group | 84 | | this\_db\_subnet\_group\_id | The db subnet group id | 85 | 86 | -------------------------------------------------------------------------------- /tests/output/generate/default/TEST-0.8.0.md: -------------------------------------------------------------------------------- 1 | ## Providers 2 | 3 | No provider. 4 | 5 | ## Inputs 6 | 7 | | Name | Description | Type | Default | Required | 8 | |------|-------------|------|---------|:-----:| 9 | | allocated\_storage | The allocated storage in gigabytes | `any` | n/a | yes | 10 | | backup\_window | The daily time range (in UTC) during which automated backups are created if they are enabled. Example: '09:46-10:16'. Must not overlap with maintenance\_window | `any` | n/a | yes | 11 | | engine | The database engine to use | `any` | n/a | yes | 12 | | engine\_version | The engine version to use | `any` | n/a | yes | 13 | | identifier | The name of the RDS instance, if omitted, Terraform will assign a random, unique identifier | `any` | n/a | yes | 14 | | instance\_class | The instance type of the RDS instance | `any` | n/a | yes | 15 | | maintenance\_window | The window to perform maintenance in. Syntax: 'ddd:hh24:mi-ddd:hh24:mi'. Eg: 'Mon:00:00-Mon:03:00' | `any` | n/a | yes | 16 | | password | Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file | `any` | n/a | yes | 17 | | port | The port on which the DB accepts connections | `any` | n/a | yes | 18 | | username | Username for the master DB user | `any` | n/a | yes | 19 | | allow\_major\_version\_upgrade | Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible | `bool` | `false` | no | 20 | | apply\_immediately | Specifies whether any database modifications are applied immediately, or during the next maintenance window | `bool` | `false` | no | 21 | | auto\_minor\_version\_upgrade | Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window | `bool` | `true` | no | 22 | | availability\_zone | The Availability Zone of the RDS instance | `string` | `""` | no | 23 | | backup\_retention\_period | The days to retain backups for | `number` | `7` | no | 24 | | character\_set\_name | (Optional) The character set name to use for DB encoding in Oracle instances. This can't be changed. See Oracle Character Sets Supported in Amazon RDS for more information | `string` | `""` | no | 25 | | copy\_tags\_to\_snapshot | On delete, copy all Instance tags to the final snapshot (if final\_snapshot\_identifier is specified) | `bool` | `false` | no | 26 | | create\_db\_instance | Whether to create a database instance | `bool` | `true` | no | 27 | | create\_db\_option\_group | Whether to create a database option group | `bool` | `true` | no | 28 | | create\_db\_parameter\_group | Whether to create a database parameter group | `bool` | `true` | no | 29 | | create\_db\_subnet\_group | Whether to create a database subnet group | `bool` | `true` | no | 30 | | create\_monitoring\_role | Create IAM role with a defined name that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. | `bool` | `false` | no | 31 | | db\_subnet\_group\_name | Name of DB subnet group. DB instance will be created in the VPC associated with the DB subnet group. If unspecified, will be created in the default VPC | `string` | `""` | no | 32 | | deletion\_protection | The database can't be deleted when this value is set to true. | `bool` | `false` | no | 33 | | enabled\_cloudwatch\_logs\_exports | List of log types to enable for exporting to CloudWatch logs. If omitted, no logs will be exported. Valid values (depending on engine): alert, audit, error, general, listener, slowquery, trace, postgresql (PostgreSQL), upgrade (PostgreSQL). | `list` | `[]` | no | 34 | | family | The family of the DB parameter group | `string` | `""` | no | 35 | | final\_snapshot\_identifier | The name of your final DB snapshot when this DB instance is deleted. | `bool` | `false` | no | 36 | | iam\_database\_authentication\_enabled | Specifies whether or mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled | `bool` | `false` | no | 37 | | iops | The amount of provisioned IOPS. Setting this implies a storage\_type of 'io1' | `number` | `0` | no | 38 | | kms\_key\_id | The ARN for the KMS encryption key. If creating an encrypted replica, set this to the destination KMS ARN. If storage\_encrypted is set to true and kms\_key\_id is not specified the default KMS key created in your account will be used | `string` | `""` | no | 39 | | license\_model | License model information for this DB instance. Optional, but required for some DB engines, i.e. Oracle SE1 | `string` | `""` | no | 40 | | major\_engine\_version | Specifies the major version of the engine that this option group should be associated with | `string` | `""` | no | 41 | | monitoring\_interval | The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. Valid Values: 0, 1, 5, 10, 15, 30, 60. | `number` | `0` | no | 42 | | monitoring\_role\_arn | The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. Must be specified if monitoring\_interval is non-zero. | `string` | `""` | no | 43 | | monitoring\_role\_name | Name of the IAM role which will be created when create\_monitoring\_role is enabled. | `string` | `"rds-monitoring-role"` | no | 44 | | multi\_az | Specifies if the RDS instance is multi-AZ | `bool` | `false` | no | 45 | | name | The DB schema name to create. If omitted, no database is created initially | `string` | `""` | no | 46 | | option\_group\_description | The description of the option group | `string` | `""` | no | 47 | | option\_group\_name | Name of the DB option group to associate. Setting this automatically disables option\_group creation | `string` | `""` | no | 48 | | options | A list of Options to apply. | `list` | `[]` | no | 49 | | parameter\_group\_description | Description of the DB parameter group to create | `string` | `""` | no | 50 | | parameter\_group\_name | Name of the DB parameter group to associate or create | `string` | `""` | no | 51 | | parameters | A list of DB parameters (map) to apply | `list` | `[]` | no | 52 | | publicly\_accessible | Bool to control if instance is publicly accessible | `bool` | `false` | no | 53 | | replicate\_source\_db | Specifies that this resource is a Replicate database, and to use this value as the source database. This correlates to the identifier of another Amazon RDS Database to replicate. | `string` | `""` | no | 54 | | skip\_final\_snapshot | Determines whether a final DB snapshot is created before the DB instance is deleted. If true is specified, no DBSnapshot is created. If false is specified, a DB snapshot is created before the DB instance is deleted, using the value from final\_snapshot\_identifier | `bool` | `false` | no | 55 | | snapshot\_identifier | Specifies whether or not to create this database from a snapshot. This correlates to the snapshot ID you'd find in the RDS console, e.g: rds:production-2015-06-26-06-05. | `string` | `""` | no | 56 | | storage\_encrypted | Specifies whether the DB instance is encrypted | `bool` | `false` | no | 57 | | storage\_type | One of 'standard' (magnetic), 'gp2' (general purpose SSD), or 'io1' (provisioned IOPS SSD). The default is 'io1' if iops is specified, 'standard' if not. Note that this behaviour is different from the AWS web console, where the default is 'gp2'. | `string` | `"gp2"` | no | 58 | | subnet\_ids | A list of VPC subnet IDs | `list` | `[]` | no | 59 | | tags | A mapping of tags to assign to all resources | `map` | `{}` | no | 60 | | timeouts | (Optional) Updated Terraform resource management timeouts. Applies to `aws_db_instance` in particular to permit resource management times | `map` | 
{
  "create": "40m",
  "delete": "40m",
  "update": "80m"
}
| no | 61 | | timezone | (Optional) Time zone of the DB instance. timezone is currently only supported by Microsoft SQL Server. The timezone can only be set on creation. See MSSQL User Guide for more information. | `string` | `""` | no | 62 | | use\_option\_group\_name\_prefix | Whether to use the option group name prefix or not | `bool` | `true` | no | 63 | | use\_parameter\_group\_name\_prefix | Whether to use the parameter group name prefix or not | `bool` | `true` | no | 64 | | use\_subnet\_group\_name\_prefix | Whether to use the subnet group name prefix or not | `bool` | `true` | no | 65 | | vpc\_security\_group\_ids | List of VPC security groups to associate | `list` | `[]` | no | 66 | 67 | ## Outputs 68 | 69 | | Name | Description | 70 | |------|-------------| 71 | | this\_db\_instance\_address | The address of the RDS instance | 72 | | this\_db\_instance\_arn | The ARN of the RDS instance | 73 | | this\_db\_instance\_availability\_zone | The availability zone of the RDS instance | 74 | | this\_db\_instance\_endpoint | The connection endpoint | 75 | | this\_db\_instance\_hosted\_zone\_id | The canonical hosted zone ID of the DB instance (to be used in a Route 53 Alias record) | 76 | | this\_db\_instance\_id | The RDS instance ID | 77 | | this\_db\_instance\_name | The database name | 78 | | this\_db\_instance\_password | The database password (this password may be old, because Terraform doesn't track it after initial creation) | 79 | | this\_db\_instance\_port | The database port | 80 | | this\_db\_instance\_resource\_id | The RDS Resource ID of this instance | 81 | | this\_db\_instance\_status | The RDS instance status | 82 | | this\_db\_instance\_username | The master username for the database | 83 | | this\_db\_option\_group\_arn | The ARN of the db option group | 84 | | this\_db\_option\_group\_id | The db option group id | 85 | | this\_db\_parameter\_group\_arn | The ARN of the db parameter group | 86 | | this\_db\_parameter\_group\_id | The db parameter group id | 87 | | this\_db\_subnet\_group\_arn | The ARN of the db subnet group | 88 | | this\_db\_subnet\_group\_id | The db subnet group id | 89 | 90 | -------------------------------------------------------------------------------- /tests/output/generate/default/TEST-0.8.1.md: -------------------------------------------------------------------------------- 1 | ## Providers 2 | 3 | No provider. 4 | 5 | ## Inputs 6 | 7 | | Name | Description | Type | Default | Required | 8 | |------|-------------|------|---------|:-----:| 9 | | allocated\_storage | The allocated storage in gigabytes | `any` | n/a | yes | 10 | | backup\_window | The daily time range (in UTC) during which automated backups are created if they are enabled. Example: '09:46-10:16'. Must not overlap with maintenance\_window | `any` | n/a | yes | 11 | | engine | The database engine to use | `any` | n/a | yes | 12 | | engine\_version | The engine version to use | `any` | n/a | yes | 13 | | identifier | The name of the RDS instance, if omitted, Terraform will assign a random, unique identifier | `any` | n/a | yes | 14 | | instance\_class | The instance type of the RDS instance | `any` | n/a | yes | 15 | | maintenance\_window | The window to perform maintenance in. Syntax: 'ddd:hh24:mi-ddd:hh24:mi'. Eg: 'Mon:00:00-Mon:03:00' | `any` | n/a | yes | 16 | | password | Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file | `any` | n/a | yes | 17 | | port | The port on which the DB accepts connections | `any` | n/a | yes | 18 | | username | Username for the master DB user | `any` | n/a | yes | 19 | | allow\_major\_version\_upgrade | Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible | `bool` | `false` | no | 20 | | apply\_immediately | Specifies whether any database modifications are applied immediately, or during the next maintenance window | `bool` | `false` | no | 21 | | auto\_minor\_version\_upgrade | Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window | `bool` | `true` | no | 22 | | availability\_zone | The Availability Zone of the RDS instance | `string` | `""` | no | 23 | | backup\_retention\_period | The days to retain backups for | `number` | `7` | no | 24 | | character\_set\_name | (Optional) The character set name to use for DB encoding in Oracle instances. This can't be changed. See Oracle Character Sets Supported in Amazon RDS for more information | `string` | `""` | no | 25 | | copy\_tags\_to\_snapshot | On delete, copy all Instance tags to the final snapshot (if final\_snapshot\_identifier is specified) | `bool` | `false` | no | 26 | | create\_db\_instance | Whether to create a database instance | `bool` | `true` | no | 27 | | create\_db\_option\_group | Whether to create a database option group | `bool` | `true` | no | 28 | | create\_db\_parameter\_group | Whether to create a database parameter group | `bool` | `true` | no | 29 | | create\_db\_subnet\_group | Whether to create a database subnet group | `bool` | `true` | no | 30 | | create\_monitoring\_role | Create IAM role with a defined name that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. | `bool` | `false` | no | 31 | | db\_subnet\_group\_name | Name of DB subnet group. DB instance will be created in the VPC associated with the DB subnet group. If unspecified, will be created in the default VPC | `string` | `""` | no | 32 | | deletion\_protection | The database can't be deleted when this value is set to true. | `bool` | `false` | no | 33 | | enabled\_cloudwatch\_logs\_exports | List of log types to enable for exporting to CloudWatch logs. If omitted, no logs will be exported. Valid values (depending on engine): alert, audit, error, general, listener, slowquery, trace, postgresql (PostgreSQL), upgrade (PostgreSQL). | `list` | `[]` | no | 34 | | family | The family of the DB parameter group | `string` | `""` | no | 35 | | final\_snapshot\_identifier | The name of your final DB snapshot when this DB instance is deleted. | `bool` | `false` | no | 36 | | iam\_database\_authentication\_enabled | Specifies whether or mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled | `bool` | `false` | no | 37 | | iops | The amount of provisioned IOPS. Setting this implies a storage\_type of 'io1' | `number` | `0` | no | 38 | | kms\_key\_id | The ARN for the KMS encryption key. If creating an encrypted replica, set this to the destination KMS ARN. If storage\_encrypted is set to true and kms\_key\_id is not specified the default KMS key created in your account will be used | `string` | `""` | no | 39 | | license\_model | License model information for this DB instance. Optional, but required for some DB engines, i.e. Oracle SE1 | `string` | `""` | no | 40 | | major\_engine\_version | Specifies the major version of the engine that this option group should be associated with | `string` | `""` | no | 41 | | monitoring\_interval | The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. Valid Values: 0, 1, 5, 10, 15, 30, 60. | `number` | `0` | no | 42 | | monitoring\_role\_arn | The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. Must be specified if monitoring\_interval is non-zero. | `string` | `""` | no | 43 | | monitoring\_role\_name | Name of the IAM role which will be created when create\_monitoring\_role is enabled. | `string` | `"rds-monitoring-role"` | no | 44 | | multi\_az | Specifies if the RDS instance is multi-AZ | `bool` | `false` | no | 45 | | name | The DB schema name to create. If omitted, no database is created initially | `string` | `""` | no | 46 | | option\_group\_description | The description of the option group | `string` | `""` | no | 47 | | option\_group\_name | Name of the DB option group to associate. Setting this automatically disables option\_group creation | `string` | `""` | no | 48 | | options | A list of Options to apply. | `list` | `[]` | no | 49 | | parameter\_group\_description | Description of the DB parameter group to create | `string` | `""` | no | 50 | | parameter\_group\_name | Name of the DB parameter group to associate or create | `string` | `""` | no | 51 | | parameters | A list of DB parameters (map) to apply | `list` | `[]` | no | 52 | | publicly\_accessible | Bool to control if instance is publicly accessible | `bool` | `false` | no | 53 | | replicate\_source\_db | Specifies that this resource is a Replicate database, and to use this value as the source database. This correlates to the identifier of another Amazon RDS Database to replicate. | `string` | `""` | no | 54 | | skip\_final\_snapshot | Determines whether a final DB snapshot is created before the DB instance is deleted. If true is specified, no DBSnapshot is created. If false is specified, a DB snapshot is created before the DB instance is deleted, using the value from final\_snapshot\_identifier | `bool` | `false` | no | 55 | | snapshot\_identifier | Specifies whether or not to create this database from a snapshot. This correlates to the snapshot ID you'd find in the RDS console, e.g: rds:production-2015-06-26-06-05. | `string` | `""` | no | 56 | | storage\_encrypted | Specifies whether the DB instance is encrypted | `bool` | `false` | no | 57 | | storage\_type | One of 'standard' (magnetic), 'gp2' (general purpose SSD), or 'io1' (provisioned IOPS SSD). The default is 'io1' if iops is specified, 'standard' if not. Note that this behaviour is different from the AWS web console, where the default is 'gp2'. | `string` | `"gp2"` | no | 58 | | subnet\_ids | A list of VPC subnet IDs | `list` | `[]` | no | 59 | | tags | A mapping of tags to assign to all resources | `map` | `{}` | no | 60 | | timeouts | (Optional) Updated Terraform resource management timeouts. Applies to `aws_db_instance` in particular to permit resource management times | `map` | 
{
  "create": "40m",
  "delete": "40m",
  "update": "80m"
}
| no | 61 | | timezone | (Optional) Time zone of the DB instance. timezone is currently only supported by Microsoft SQL Server. The timezone can only be set on creation. See MSSQL User Guide for more information. | `string` | `""` | no | 62 | | use\_option\_group\_name\_prefix | Whether to use the option group name prefix or not | `bool` | `true` | no | 63 | | use\_parameter\_group\_name\_prefix | Whether to use the parameter group name prefix or not | `bool` | `true` | no | 64 | | use\_subnet\_group\_name\_prefix | Whether to use the subnet group name prefix or not | `bool` | `true` | no | 65 | | vpc\_security\_group\_ids | List of VPC security groups to associate | `list` | `[]` | no | 66 | 67 | ## Outputs 68 | 69 | | Name | Description | 70 | |------|-------------| 71 | | this\_db\_instance\_address | The address of the RDS instance | 72 | | this\_db\_instance\_arn | The ARN of the RDS instance | 73 | | this\_db\_instance\_availability\_zone | The availability zone of the RDS instance | 74 | | this\_db\_instance\_endpoint | The connection endpoint | 75 | | this\_db\_instance\_hosted\_zone\_id | The canonical hosted zone ID of the DB instance (to be used in a Route 53 Alias record) | 76 | | this\_db\_instance\_id | The RDS instance ID | 77 | | this\_db\_instance\_name | The database name | 78 | | this\_db\_instance\_password | The database password (this password may be old, because Terraform doesn't track it after initial creation) | 79 | | this\_db\_instance\_port | The database port | 80 | | this\_db\_instance\_resource\_id | The RDS Resource ID of this instance | 81 | | this\_db\_instance\_status | The RDS instance status | 82 | | this\_db\_instance\_username | The master username for the database | 83 | | this\_db\_option\_group\_arn | The ARN of the db option group | 84 | | this\_db\_option\_group\_id | The db option group id | 85 | | this\_db\_parameter\_group\_arn | The ARN of the db parameter group | 86 | | this\_db\_parameter\_group\_id | The db parameter group id | 87 | | this\_db\_subnet\_group\_arn | The ARN of the db subnet group | 88 | | this\_db\_subnet\_group\_id | The db subnet group id | 89 | 90 | -------------------------------------------------------------------------------- /tests/output/generate/default/TEST-0.8.2.md: -------------------------------------------------------------------------------- 1 | ## Providers 2 | 3 | No provider. 4 | 5 | ## Inputs 6 | 7 | | Name | Description | Type | Default | Required | 8 | |------|-------------|------|---------|:-----:| 9 | | allocated\_storage | The allocated storage in gigabytes | `any` | n/a | yes | 10 | | backup\_window | The daily time range (in UTC) during which automated backups are created if they are enabled. Example: '09:46-10:16'. Must not overlap with maintenance\_window | `any` | n/a | yes | 11 | | engine | The database engine to use | `any` | n/a | yes | 12 | | engine\_version | The engine version to use | `any` | n/a | yes | 13 | | identifier | The name of the RDS instance, if omitted, Terraform will assign a random, unique identifier | `any` | n/a | yes | 14 | | instance\_class | The instance type of the RDS instance | `any` | n/a | yes | 15 | | maintenance\_window | The window to perform maintenance in. Syntax: 'ddd:hh24:mi-ddd:hh24:mi'. Eg: 'Mon:00:00-Mon:03:00' | `any` | n/a | yes | 16 | | password | Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file | `any` | n/a | yes | 17 | | port | The port on which the DB accepts connections | `any` | n/a | yes | 18 | | username | Username for the master DB user | `any` | n/a | yes | 19 | | allow\_major\_version\_upgrade | Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible | `bool` | `false` | no | 20 | | apply\_immediately | Specifies whether any database modifications are applied immediately, or during the next maintenance window | `bool` | `false` | no | 21 | | auto\_minor\_version\_upgrade | Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window | `bool` | `true` | no | 22 | | availability\_zone | The Availability Zone of the RDS instance | `string` | `""` | no | 23 | | backup\_retention\_period | The days to retain backups for | `number` | `7` | no | 24 | | character\_set\_name | (Optional) The character set name to use for DB encoding in Oracle instances. This can't be changed. See Oracle Character Sets Supported in Amazon RDS for more information | `string` | `""` | no | 25 | | copy\_tags\_to\_snapshot | On delete, copy all Instance tags to the final snapshot (if final\_snapshot\_identifier is specified) | `bool` | `false` | no | 26 | | create\_db\_instance | Whether to create a database instance | `bool` | `true` | no | 27 | | create\_db\_option\_group | Whether to create a database option group | `bool` | `true` | no | 28 | | create\_db\_parameter\_group | Whether to create a database parameter group | `bool` | `true` | no | 29 | | create\_db\_subnet\_group | Whether to create a database subnet group | `bool` | `true` | no | 30 | | create\_monitoring\_role | Create IAM role with a defined name that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. | `bool` | `false` | no | 31 | | db\_subnet\_group\_name | Name of DB subnet group. DB instance will be created in the VPC associated with the DB subnet group. If unspecified, will be created in the default VPC | `string` | `""` | no | 32 | | deletion\_protection | The database can't be deleted when this value is set to true. | `bool` | `false` | no | 33 | | enabled\_cloudwatch\_logs\_exports | List of log types to enable for exporting to CloudWatch logs. If omitted, no logs will be exported. Valid values (depending on engine): alert, audit, error, general, listener, slowquery, trace, postgresql (PostgreSQL), upgrade (PostgreSQL). | `list` | `[]` | no | 34 | | family | The family of the DB parameter group | `string` | `""` | no | 35 | | final\_snapshot\_identifier | The name of your final DB snapshot when this DB instance is deleted. | `bool` | `false` | no | 36 | | iam\_database\_authentication\_enabled | Specifies whether or mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled | `bool` | `false` | no | 37 | | iops | The amount of provisioned IOPS. Setting this implies a storage\_type of 'io1' | `number` | `0` | no | 38 | | kms\_key\_id | The ARN for the KMS encryption key. If creating an encrypted replica, set this to the destination KMS ARN. If storage\_encrypted is set to true and kms\_key\_id is not specified the default KMS key created in your account will be used | `string` | `""` | no | 39 | | license\_model | License model information for this DB instance. Optional, but required for some DB engines, i.e. Oracle SE1 | `string` | `""` | no | 40 | | major\_engine\_version | Specifies the major version of the engine that this option group should be associated with | `string` | `""` | no | 41 | | monitoring\_interval | The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. Valid Values: 0, 1, 5, 10, 15, 30, 60. | `number` | `0` | no | 42 | | monitoring\_role\_arn | The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. Must be specified if monitoring\_interval is non-zero. | `string` | `""` | no | 43 | | monitoring\_role\_name | Name of the IAM role which will be created when create\_monitoring\_role is enabled. | `string` | `"rds-monitoring-role"` | no | 44 | | multi\_az | Specifies if the RDS instance is multi-AZ | `bool` | `false` | no | 45 | | name | The DB schema name to create. If omitted, no database is created initially | `string` | `""` | no | 46 | | option\_group\_description | The description of the option group | `string` | `""` | no | 47 | | option\_group\_name | Name of the DB option group to associate. Setting this automatically disables option\_group creation | `string` | `""` | no | 48 | | options | A list of Options to apply. | `list` | `[]` | no | 49 | | parameter\_group\_description | Description of the DB parameter group to create | `string` | `""` | no | 50 | | parameter\_group\_name | Name of the DB parameter group to associate or create | `string` | `""` | no | 51 | | parameters | A list of DB parameters (map) to apply | `list` | `[]` | no | 52 | | publicly\_accessible | Bool to control if instance is publicly accessible | `bool` | `false` | no | 53 | | replicate\_source\_db | Specifies that this resource is a Replicate database, and to use this value as the source database. This correlates to the identifier of another Amazon RDS Database to replicate. | `string` | `""` | no | 54 | | skip\_final\_snapshot | Determines whether a final DB snapshot is created before the DB instance is deleted. If true is specified, no DBSnapshot is created. If false is specified, a DB snapshot is created before the DB instance is deleted, using the value from final\_snapshot\_identifier | `bool` | `false` | no | 55 | | snapshot\_identifier | Specifies whether or not to create this database from a snapshot. This correlates to the snapshot ID you'd find in the RDS console, e.g: rds:production-2015-06-26-06-05. | `string` | `""` | no | 56 | | storage\_encrypted | Specifies whether the DB instance is encrypted | `bool` | `false` | no | 57 | | storage\_type | One of 'standard' (magnetic), 'gp2' (general purpose SSD), or 'io1' (provisioned IOPS SSD). The default is 'io1' if iops is specified, 'standard' if not. Note that this behaviour is different from the AWS web console, where the default is 'gp2'. | `string` | `"gp2"` | no | 58 | | subnet\_ids | A list of VPC subnet IDs | `list` | `[]` | no | 59 | | tags | A mapping of tags to assign to all resources | `map` | `{}` | no | 60 | | timeouts | (Optional) Updated Terraform resource management timeouts. Applies to `aws_db_instance` in particular to permit resource management times | `map` | 
{
  "create": "40m",
  "delete": "40m",
  "update": "80m"
}
| no | 61 | | timezone | (Optional) Time zone of the DB instance. timezone is currently only supported by Microsoft SQL Server. The timezone can only be set on creation. See MSSQL User Guide for more information. | `string` | `""` | no | 62 | | use\_option\_group\_name\_prefix | Whether to use the option group name prefix or not | `bool` | `true` | no | 63 | | use\_parameter\_group\_name\_prefix | Whether to use the parameter group name prefix or not | `bool` | `true` | no | 64 | | use\_subnet\_group\_name\_prefix | Whether to use the subnet group name prefix or not | `bool` | `true` | no | 65 | | vpc\_security\_group\_ids | List of VPC security groups to associate | `list` | `[]` | no | 66 | 67 | ## Outputs 68 | 69 | | Name | Description | 70 | |------|-------------| 71 | | this\_db\_instance\_address | The address of the RDS instance | 72 | | this\_db\_instance\_arn | The ARN of the RDS instance | 73 | | this\_db\_instance\_availability\_zone | The availability zone of the RDS instance | 74 | | this\_db\_instance\_endpoint | The connection endpoint | 75 | | this\_db\_instance\_hosted\_zone\_id | The canonical hosted zone ID of the DB instance (to be used in a Route 53 Alias record) | 76 | | this\_db\_instance\_id | The RDS instance ID | 77 | | this\_db\_instance\_name | The database name | 78 | | this\_db\_instance\_password | The database password (this password may be old, because Terraform doesn't track it after initial creation) | 79 | | this\_db\_instance\_port | The database port | 80 | | this\_db\_instance\_resource\_id | The RDS Resource ID of this instance | 81 | | this\_db\_instance\_status | The RDS instance status | 82 | | this\_db\_instance\_username | The master username for the database | 83 | | this\_db\_option\_group\_arn | The ARN of the db option group | 84 | | this\_db\_option\_group\_id | The db option group id | 85 | | this\_db\_parameter\_group\_arn | The ARN of the db parameter group | 86 | | this\_db\_parameter\_group\_id | The db parameter group id | 87 | | this\_db\_subnet\_group\_arn | The ARN of the db subnet group | 88 | | this\_db\_subnet\_group\_id | The db subnet group id | 89 | 90 | -------------------------------------------------------------------------------- /tests/output/replace/default/TEST-0.5.0.md: -------------------------------------------------------------------------------- 1 | # Test 2 | 3 | Stuff before terraform-docs 4 | 5 | 6 | ## Inputs 7 | 8 | | Name | Description | Type | Default | Required | 9 | |------|-------------|:----:|:-----:|:-----:| 10 | | allocated\_storage | The allocated storage in gigabytes | string | - | yes | 11 | | backup\_window | The daily time range (in UTC) during which automated backups are created if they are enabled. Example: '09:46-10:16'. Must not overlap with maintenance_window | string | - | yes | 12 | | engine | The database engine to use | string | - | yes | 13 | | engine\_version | The engine version to use | string | - | yes | 14 | | identifier | The name of the RDS instance, if omitted, Terraform will assign a random, unique identifier | string | - | yes | 15 | | instance\_class | The instance type of the RDS instance | string | - | yes | 16 | | maintenance\_window | The window to perform maintenance in. Syntax: 'ddd:hh24:mi-ddd:hh24:mi'. Eg: 'Mon:00:00-Mon:03:00' | string | - | yes | 17 | | password | Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file | string | - | yes | 18 | | port | The port on which the DB accepts connections | string | - | yes | 19 | | username | Username for the master DB user | string | - | yes | 20 | | allow\_major\_version\_upgrade | Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible | string | `false` | no | 21 | | apply\_immediately | Specifies whether any database modifications are applied immediately, or during the next maintenance window | string | `false` | no | 22 | | auto\_minor\_version\_upgrade | Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window | string | `true` | no | 23 | | availability\_zone | The Availability Zone of the RDS instance | string | `` | no | 24 | | backup\_retention\_period | The days to retain backups for | string | `7` | no | 25 | | character\_set\_name | (Optional) The character set name to use for DB encoding in Oracle instances. This can't be changed. See Oracle Character Sets Supported in Amazon RDS for more information | string | `` | no | 26 | | copy\_tags\_to\_snapshot | On delete, copy all Instance tags to the final snapshot (if final_snapshot_identifier is specified) | string | `false` | no | 27 | | create\_db\_instance | Whether to create a database instance | string | `true` | no | 28 | | create\_db\_option\_group | Whether to create a database option group | string | `true` | no | 29 | | create\_db\_parameter\_group | Whether to create a database parameter group | string | `true` | no | 30 | | create\_db\_subnet\_group | Whether to create a database subnet group | string | `true` | no | 31 | | create\_monitoring\_role | Create IAM role with a defined name that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. | string | `false` | no | 32 | | db\_subnet\_group\_name | Name of DB subnet group. DB instance will be created in the VPC associated with the DB subnet group. If unspecified, will be created in the default VPC | string | `` | no | 33 | | deletion\_protection | The database can't be deleted when this value is set to true. | string | `false` | no | 34 | | enabled\_cloudwatch\_logs\_exports | List of log types to enable for exporting to CloudWatch logs. If omitted, no logs will be exported. Valid values (depending on engine): alert, audit, error, general, listener, slowquery, trace, postgresql (PostgreSQL), upgrade (PostgreSQL). | list | `[]` | no | 35 | | family | The family of the DB parameter group | string | `` | no | 36 | | final\_snapshot\_identifier | The name of your final DB snapshot when this DB instance is deleted. | string | `false` | no | 37 | | iam\_database\_authentication\_enabled | Specifies whether or mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled | string | `false` | no | 38 | | iops | The amount of provisioned IOPS. Setting this implies a storage_type of 'io1' | string | `0` | no | 39 | | kms\_key\_id | The ARN for the KMS encryption key. If creating an encrypted replica, set this to the destination KMS ARN. If storage_encrypted is set to true and kms_key_id is not specified the default KMS key created in your account will be used | string | `` | no | 40 | | license\_model | License model information for this DB instance. Optional, but required for some DB engines, i.e. Oracle SE1 | string | `` | no | 41 | | major\_engine\_version | Specifies the major version of the engine that this option group should be associated with | string | `` | no | 42 | | monitoring\_interval | The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. Valid Values: 0, 1, 5, 10, 15, 30, 60. | string | `0` | no | 43 | | monitoring\_role\_arn | The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. Must be specified if monitoring_interval is non-zero. | string | `` | no | 44 | | monitoring\_role\_name | Name of the IAM role which will be created when create_monitoring_role is enabled. | string | `rds-monitoring-role` | no | 45 | | multi\_az | Specifies if the RDS instance is multi-AZ | string | `false` | no | 46 | | name | The DB schema name to create. If omitted, no database is created initially | string | `` | no | 47 | | option\_group\_description | The description of the option group | string | `` | no | 48 | | option\_group\_name | Name of the DB option group to associate. Setting this automatically disables option_group creation | string | `` | no | 49 | | options | A list of Options to apply. | list | `[]` | no | 50 | | parameter\_group\_description | Description of the DB parameter group to create | string | `` | no | 51 | | parameter\_group\_name | Name of the DB parameter group to associate or create | string | `` | no | 52 | | parameters | A list of DB parameters (map) to apply | list | `[]` | no | 53 | | publicly\_accessible | Bool to control if instance is publicly accessible | string | `false` | no | 54 | | replicate\_source\_db | Specifies that this resource is a Replicate database, and to use this value as the source database. This correlates to the identifier of another Amazon RDS Database to replicate. | string | `` | no | 55 | | skip\_final\_snapshot | Determines whether a final DB snapshot is created before the DB instance is deleted. If true is specified, no DBSnapshot is created. If false is specified, a DB snapshot is created before the DB instance is deleted, using the value from final_snapshot_identifier | string | `false` | no | 56 | | snapshot\_identifier | Specifies whether or not to create this database from a snapshot. This correlates to the snapshot ID you'd find in the RDS console, e.g: rds:production-2015-06-26-06-05. | string | `` | no | 57 | | storage\_encrypted | Specifies whether the DB instance is encrypted | string | `false` | no | 58 | | storage\_type | One of 'standard' (magnetic), 'gp2' (general purpose SSD), or 'io1' (provisioned IOPS SSD). The default is 'io1' if iops is specified, 'standard' if not. Note that this behaviour is different from the AWS web console, where the default is 'gp2'. | string | `gp2` | no | 59 | | subnet\_ids | A list of VPC subnet IDs | list | `[]` | no | 60 | | tags | A mapping of tags to assign to all resources | map | `{}` | no | 61 | | timeouts | (Optional) Updated Terraform resource management timeouts. Applies to `aws_db_instance` in particular to permit resource management times | map | `{ "create": "40m", "delete": "40m", "update": "80m" }` | no | 62 | | timezone | (Optional) Time zone of the DB instance. timezone is currently only supported by Microsoft SQL Server. The timezone can only be set on creation. See MSSQL User Guide for more information. | string | `` | no | 63 | | use\_option\_group\_name\_prefix | Whether to use the option group name prefix or not | string | `true` | no | 64 | | use\_parameter\_group\_name\_prefix | Whether to use the parameter group name prefix or not | string | `true` | no | 65 | | use\_subnet\_group\_name\_prefix | Whether to use the subnet group name prefix or not | string | `true` | no | 66 | | vpc\_security\_group\_ids | List of VPC security groups to associate | list | `[]` | no | 67 | 68 | ## Outputs 69 | 70 | | Name | Description | 71 | |------|-------------| 72 | | this\_db\_instance\_address | The address of the RDS instance | 73 | | this\_db\_instance\_arn | The ARN of the RDS instance | 74 | | this\_db\_instance\_availability\_zone | The availability zone of the RDS instance | 75 | | this\_db\_instance\_endpoint | The connection endpoint | 76 | | this\_db\_instance\_hosted\_zone\_id | The canonical hosted zone ID of the DB instance (to be used in a Route 53 Alias record) | 77 | | this\_db\_instance\_id | The RDS instance ID | 78 | | this\_db\_instance\_name | The database name | 79 | | this\_db\_instance\_password | The database password (this password may be old, because Terraform doesn't track it after initial creation) | 80 | | this\_db\_instance\_port | The database port | 81 | | this\_db\_instance\_resource\_id | The RDS Resource ID of this instance | 82 | | this\_db\_instance\_status | The RDS instance status | 83 | | this\_db\_instance\_username | The master username for the database | 84 | | this\_db\_option\_group\_arn | The ARN of the db option group | 85 | | this\_db\_option\_group\_id | The db option group id | 86 | | this\_db\_parameter\_group\_arn | The ARN of the db parameter group | 87 | | this\_db\_parameter\_group\_id | The db parameter group id | 88 | | this\_db\_subnet\_group\_arn | The ARN of the db subnet group | 89 | | this\_db\_subnet\_group\_id | The db subnet group id | 90 | 91 | 92 | 93 | Stuff after terraform-docs 94 | --------------------------------------------------------------------------------