Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: add zone_name and zone_id to readme #67

Closed
wants to merge 2 commits into from
Closed

docs: add zone_name and zone_id to readme #67

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cec0f6d
docs: add zone_name and zone_id to readme
nitrocode Mar 3, 2023
7ffb9c4
Merge branch 'main' into add-zone-name-to-docs
max-lobur May 9, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions README.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,9 +41,11 @@ related:
- name: "terraform-aws-alb"
description: "Terraform module to provision a standard ALB for HTTP/HTTP traffic"
url: "https://github.com/cloudposse/terraform-aws-alb"

# Short description of this project
description: |-
Terraform module to request an ACM certificate for a domain and add a CNAME record to the DNS zone to complete certificate validation

# How to use this project
usage: |-
This example will request an SSL certificate for `example.com` domain
Expand All @@ -53,6 +55,11 @@ usage: |-
source = "cloudposse/acm-request-certificate/aws"
# Cloud Posse recommends pinning every module to a specific version
# version = "x.x.x"

# zone_id and zone_name are optional. If omitted, the module will try to
# calculate which zone_name to add the validation records to using both
# domain_name and subject_alternative_names
zone_name = "example.com"
domain_name = "example.com"
process_domain_validation_options = true
ttl = "300"
Expand All @@ -66,15 +73,22 @@ usage: |-
source = "cloudposse/acm-request-certificate/aws"
# Cloud Posse recommends pinning every module to a specific version
# version = "x.x.x"

# zone_id and zone_name are optional. If omitted, the module will try to
# calculate which zone_name to add the validation records to using both
# domain_name and subject_alternative_names
zone_name = "example.com"
domain_name = "example.com"
process_domain_validation_options = true
ttl = "300"
subject_alternative_names = ["*.example.com"]
}
```

include:
- "docs/targets.md"
- "docs/terraform.md"

# Contributors to this project
contributors:
- name: "Andriy Knysh"
Expand Down
Loading