Skip to content

Commit 684fd17

Browse files
committed
Updated README
1 parent dfe5447 commit 684fd17

File tree

5 files changed

+59
-15
lines changed

5 files changed

+59
-15
lines changed

Diff for: .pre-commit-config.yaml

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
repos:
22
- repo: git://github.com/antonbabenko/pre-commit-terraform
3-
rev: v1.27.0
3+
rev: v1.31.0
44
hooks:
55
- id: terraform_fmt
66
- id: terraform_docs
77
- repo: git://github.com/pre-commit/pre-commit-hooks
8-
rev: v2.5.0
8+
rev: v3.1.0
99
hooks:
1010
- id: check-merge-conflict

Diff for: README.md

+24-11
Original file line numberDiff line numberDiff line change
@@ -64,20 +64,33 @@ module "acm" {
6464
* `domain_name` can not be wildcard, but `subject_alternative_names` can include wildcards.
6565

6666
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
67+
## Requirements
68+
69+
| Name | Version |
70+
|------|---------|
71+
| terraform | >= 0.12.6, < 0.14 |
72+
| aws | ~> 2.53 |
73+
74+
## Providers
75+
76+
| Name | Version |
77+
|------|---------|
78+
| aws | ~> 2.53 |
79+
6780
## Inputs
6881

6982
| Name | Description | Type | Default | Required |
70-
|------|-------------|:----:|:-----:|:-----:|
71-
| certificate\_transparency\_logging\_preference | Specifies whether certificate details should be added to a certificate transparency log | bool | `"false"` | no |
72-
| create\_certificate | Whether to create ACM certificate | bool | `"true"` | no |
73-
| domain\_name | A domain name for which the certificate should be issued | string | `""` | no |
74-
| subject\_alternative\_names | A list of domains that should be SANs in the issued certificate | list(string) | `[]` | no |
75-
| tags | A mapping of tags to assign to the resource | map(string) | `{}` | no |
76-
| validate\_certificate | Whether to validate certificate by creating Route53 record | bool | `"true"` | no |
77-
| validation\_allow\_overwrite\_records | Whether to allow overwrite of Route53 records | bool | `"true"` | no |
78-
| validation\_method | Which method to use for validation. DNS or EMAIL are valid, NONE can be used for certificates that were imported into ACM and then into Terraform. | string | `"DNS"` | no |
79-
| wait\_for\_validation | Whether to wait for the validation to complete | bool | `"true"` | no |
80-
| zone\_id | The ID of the hosted zone to contain this record. | string | `""` | no |
83+
|------|-------------|------|---------|:--------:|
84+
| certificate\_transparency\_logging\_preference | Specifies whether certificate details should be added to a certificate transparency log | `bool` | `false` | no |
85+
| create\_certificate | Whether to create ACM certificate | `bool` | `true` | no |
86+
| domain\_name | A domain name for which the certificate should be issued | `string` | `""` | no |
87+
| subject\_alternative\_names | A list of domains that should be SANs in the issued certificate | `list(string)` | `[]` | no |
88+
| tags | A mapping of tags to assign to the resource | `map(string)` | `{}` | no |
89+
| validate\_certificate | Whether to validate certificate by creating Route53 record | `bool` | `true` | no |
90+
| validation\_allow\_overwrite\_records | Whether to allow overwrite of Route53 records | `bool` | `true` | no |
91+
| validation\_method | Which method to use for validation. DNS or EMAIL are valid, NONE can be used for certificates that were imported into ACM and then into Terraform. | `string` | `"DNS"` | no |
92+
| wait\_for\_validation | Whether to wait for the validation to complete | `bool` | `true` | no |
93+
| zone\_id | The ID of the hosted zone to contain this record. | `string` | `""` | no |
8194

8295
## Outputs
8396

Diff for: examples/complete-dns-validation/README.md

+14
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,20 @@ $ terraform apply
1919
Note that this example may create resources which cost money. Run `terraform destroy` when you don't need these resources.
2020

2121
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
22+
## Requirements
23+
24+
No requirements.
25+
26+
## Providers
27+
28+
| Name | Version |
29+
|------|---------|
30+
| aws | n/a |
31+
32+
## Inputs
33+
34+
No input.
35+
2236
## Outputs
2337

2438
| Name | Description |

Diff for: examples/complete-email-validation/README.md

+12-2
Original file line numberDiff line numberDiff line change
@@ -32,11 +32,21 @@ $ terraform apply
3232
Note that this example may create resources which cost money. Run `terraform destroy` when you don't need these resources.
3333

3434
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
35+
## Requirements
36+
37+
No requirements.
38+
39+
## Providers
40+
41+
| Name | Version |
42+
|------|---------|
43+
| aws | n/a |
44+
3545
## Inputs
3646

3747
| Name | Description | Type | Default | Required |
38-
|------|-------------|:----:|:-----:|:-----:|
39-
| domain\_name | Domain name to use as Route53 zone and ACM certificate | string | `"my-domain-name2.com"` | no |
48+
|------|-------------|------|---------|:--------:|
49+
| domain\_name | Domain name to use as Route53 zone and ACM certificate | `string` | `"my-domain-name2.com"` | no |
4050

4151
## Outputs
4252

Diff for: versions.tf

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
terraform {
2+
required_version = ">= 0.12.6, < 0.14"
3+
4+
required_providers {
5+
aws = "~> 2.53"
6+
}
7+
}

0 commit comments

Comments
 (0)