Skip to content

Commit 1236696

Browse files
philwinderaknysh
philwinder
authored and
aknysh
committed
readme: typo in example (#7)
1 parent 40ebc5f commit 1236696

File tree

4 files changed

+37
-35
lines changed

4 files changed

+37
-35
lines changed

‎README.md

Lines changed: 25 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -32,22 +32,22 @@ This example will request an SSL certificate for `example.com` domain
3232

3333
```hcl
3434
module "acm_request_certificate" {
35-
source = "git::https://github.com/cloudposse/terraform-aws-acm-request-certificate.git?ref=master"
36-
domain_name = "example.com"
37-
proces_domain_validation_options = "true"
38-
ttl = "300"
35+
source = "git::https://github.com/cloudposse/terraform-aws-acm-request-certificate.git?ref=master"
36+
domain_name = "example.com"
37+
process_domain_validation_options = "true"
38+
ttl = "300"
3939
}
4040
```
4141

4242
This example will request an SSL certificate for `example.com` domain and all its subdomains `*.example.com`
4343

4444
```hcl
4545
module "acm_request_certificate" {
46-
source = "git::https://github.com/cloudposse/terraform-aws-acm-request-certificate.git?ref=master"
47-
domain_name = "example.com"
48-
proces_domain_validation_options = "true"
49-
ttl = "300"
50-
subject_alternative_names = ["*.example.com"]
46+
source = "git::https://github.com/cloudposse/terraform-aws-acm-request-certificate.git?ref=master"
47+
domain_name = "example.com"
48+
process_domain_validation_options = "true"
49+
ttl = "300"
50+
subject_alternative_names = ["*.example.com"]
5151
}
5252
```
5353

@@ -60,30 +60,31 @@ module "acm_request_certificate" {
6060
```
6161
Available targets:
6262
63-
help This help screen
63+
help Help screen
6464
help/all Display help for all targets
65+
help/short This help short screen
6566
lint Lint terraform code
6667
6768
```
6869

6970
## Inputs
7071

71-
| Name | Description | Type | Default | Required |
72-
|------|-------------|:----:|:-----:|:-----:|
73-
| domain_name | A domain name for which the certificate should be issued | string | - | yes |
74-
| proces_domain_validation_options | Flag to enable/disable processing of the record to add to the DNS zone to complete certificate validation | string | `true` | no |
75-
| subject_alternative_names | A list of domains that should be SANs in the issued certificate | list | `<list>` | no |
76-
| tags | Additional tags (e.g. map('BusinessUnit`,`XYZ`) | map | `<map>` | no |
77-
| ttl | The TTL of the record to add to the DNS zone to complete certificate validation | string | `300` | no |
78-
| validation_method | Which method to use for validation, DNS or EMAIL | string | `DNS` | no |
72+
| Name | Description | Type | Default | Required |
73+
| --------------------------------- | --------------------------------------------------------------------------------------------------------- | :----: | :------: | :------: |
74+
| domain_name | A domain name for which the certificate should be issued | string | - | yes |
75+
| process_domain_validation_options | Flag to enable/disable processing of the record to add to the DNS zone to complete certificate validation | string | `true` | no |
76+
| subject_alternative_names | A list of domains that should be SANs in the issued certificate | list | `<list>` | no |
77+
| tags | Additional tags (e.g. map('BusinessUnit`,`XYZ`) | map | `<map>` | no |
78+
| ttl | The TTL of the record to add to the DNS zone to complete certificate validation | string | `300` | no |
79+
| validation_method | Which method to use for validation, DNS or EMAIL | string | `DNS` | no |
7980

8081
## Outputs
8182

82-
| Name | Description |
83-
|------|-------------|
84-
| arn | The ARN of the certificate |
83+
| Name | Description |
84+
| ------------------------- | ------------------------------------------------------------------------------- |
85+
| arn | The ARN of the certificate |
8586
| domain_validation_options | CNAME records that are added to the DNS zone to complete certificate validation |
86-
| id | The ARN of the certificate |
87+
| id | The ARN of the certificate |
8788

8889

8990

@@ -212,8 +213,8 @@ Check out [our other projects][github], [apply for a job][jobs], or [hire us][hi
212213

213214
### Contributors
214215

215-
| [![Andriy Knysh][aknysh_avatar]][aknysh_homepage]<br/>[Andriy Knysh][aknysh_homepage] | [![Vladimir][SweetOps_avatar]][SweetOps_homepage]<br/>[Vladimir][SweetOps_homepage] |
216-
|---|---|
216+
| [![Andriy Knysh][aknysh_avatar]][aknysh_homepage]<br/>[Andriy Knysh][aknysh_homepage] | [![Vladimir][SweetOps_avatar]][SweetOps_homepage]<br/>[Vladimir][SweetOps_homepage] |
217+
| ------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
217218

218219
[aknysh_homepage]: https://github.com/aknysh
219220
[aknysh_avatar]: https://github.com/aknysh.png?size=150

‎README.yaml

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -46,22 +46,22 @@ usage: |-
4646
4747
```hcl
4848
module "acm_request_certificate" {
49-
source = "git::https://github.com/cloudposse/terraform-aws-acm-request-certificate.git?ref=master"
50-
domain_name = "example.com"
51-
proces_domain_validation_options = "true"
52-
ttl = "300"
49+
source = "git::https://github.com/cloudposse/terraform-aws-acm-request-certificate.git?ref=master"
50+
domain_name = "example.com"
51+
process_domain_validation_options = "true"
52+
ttl = "300"
5353
}
5454
```
5555
5656
This example will request an SSL certificate for `example.com` domain and all its subdomains `*.example.com`
5757
5858
```hcl
5959
module "acm_request_certificate" {
60-
source = "git::https://github.com/cloudposse/terraform-aws-acm-request-certificate.git?ref=master"
61-
domain_name = "example.com"
62-
proces_domain_validation_options = "true"
63-
ttl = "300"
64-
subject_alternative_names = ["*.example.com"]
60+
source = "git::https://github.com/cloudposse/terraform-aws-acm-request-certificate.git?ref=master"
61+
domain_name = "example.com"
62+
process_domain_validation_options = "true"
63+
ttl = "300"
64+
subject_alternative_names = ["*.example.com"]
6565
}
6666
```
6767

‎docs/targets.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,9 @@
22
```
33
Available targets:
44
5-
help This help screen
5+
help Help screen
66
help/all Display help for all targets
7+
help/short This help short screen
78
lint Lint terraform code
89
910
```

‎docs/terraform.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
| Name | Description | Type | Default | Required |
55
|------|-------------|:----:|:-----:|:-----:|
66
| domain_name | A domain name for which the certificate should be issued | string | - | yes |
7-
| proces_domain_validation_options | Flag to enable/disable processing of the record to add to the DNS zone to complete certificate validation | string | `true` | no |
7+
| process_domain_validation_options | Flag to enable/disable processing of the record to add to the DNS zone to complete certificate validation | string | `true` | no |
88
| subject_alternative_names | A list of domains that should be SANs in the issued certificate | list | `<list>` | no |
99
| tags | Additional tags (e.g. map('BusinessUnit`,`XYZ`) | map | `<map>` | no |
1010
| ttl | The TTL of the record to add to the DNS zone to complete certificate validation | string | `300` | no |

0 commit comments

Comments
 (0)