Skip to content

Commit aacf1df

Browse files
Co-authored-by: docs-sourcer[bot] <99042413+docs-sourcer[bot]@users.noreply.github.com>
1 parent 8dc014c commit aacf1df

File tree

4 files changed

+75
-31
lines changed

4 files changed

+75
-31
lines changed

docs/reference/modules/terraform-aws-load-balancer/acm-tls-certificate/acm-tls-certificate.md

Lines changed: 53 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,13 @@ import VersionBadge from '../../../../../src/components/VersionBadge.tsx';
99
import { HclListItem, HclListItemDescription, HclListItemTypeDetails, HclListItemDefaultValue, HclGeneralListItem } from '../../../../../src/components/HclListItem.tsx';
1010
import { ModuleUsage } from "../../../../../src/components/ModuleUsage";
1111

12-
<VersionBadge repoTitle="Load Balancer Modules" version="0.29.18" lastModifiedVersion="0.29.18"/>
12+
<VersionBadge repoTitle="Load Balancer Modules" version="0.29.19" lastModifiedVersion="0.29.19"/>
1313

1414
# ACM TLS Certificate
1515

16-
<a href="https://github.com/gruntwork-io/terraform-aws-load-balancer/tree/v0.29.18/modules/acm-tls-certificate" className="link-button" title="View the source code for this module in GitHub.">View Source</a>
16+
<a href="https://github.com/gruntwork-io/terraform-aws-load-balancer/tree/v0.29.19/modules/acm-tls-certificate" className="link-button" title="View the source code for this module in GitHub.">View Source</a>
1717

18-
<a href="https://github.com/gruntwork-io/terraform-aws-load-balancer/releases/tag/v0.29.18" className="link-button" title="Release notes for only versions which impacted this module.">Release Notes</a>
18+
<a href="https://github.com/gruntwork-io/terraform-aws-load-balancer/releases/tag/v0.29.19" className="link-button" title="Release notes for only versions which impacted this module.">Release Notes</a>
1919

2020
This module can be used to issue and validate free, auto-renewing TLS certificates using [AWS Certificate
2121
Manager (ACM)](https://aws.amazon.com/certificate-manager/). It supports issuing and validating multiple ACM certificates.
@@ -105,6 +105,33 @@ acm_tls_certificates = {
105105
}
106106
```
107107

108+
## Requesting a certificate for a subdomain with a subject alternative name that uses a unique hosted zone
109+
110+
If you are requesting a a certificate for a subdomain with a subject alternative name where both use a unique (and different) hosted zone that differes from the zone used by the parent/root domain, then you will need to specify a domain:zone mapping using the var `domain_hosted_zone_ids`.
111+
112+
Assume that you want a wildcard certificate created for '*.foo.acm-test.test-domain.in' with a subject alternative name of '*.bar.acm-test.test-domain.in.' In this example, the subdomain 'acm-test.test-domain.in' uses zone ID Z11111, the subdomain 'foo.acm-test.test-domain.in' uses zone ID Z12345 and the subdomain 'bar.acm-test.test-domain.in' uses zone ID Z67890. In order for certificate validation records to be created in the correct zone, a domain:zone mapping can be specified similar to the following example:
113+
114+
```
115+
acm_tls_certificates = {
116+
"*.foo.acm-test.test-domain.in" = {
117+
subject_alternative_names = ["*.bar.acm-test.test-domain.in"]
118+
tags = {
119+
test-tag-1 = true
120+
}
121+
create_verification_record = true
122+
verify_certificate = true
123+
}
124+
}
125+
domain_hosted_zone_ids = {
126+
"*.foo.acm-test.test-domain.in" = "Z12345"
127+
"*.bar.acm-test.test-domain.in" = "Z67890"
128+
}
129+
```
130+
131+
This will allow the validation records for 'foo.acm-test.test-domain.in' to be created in zone Z12345, and the validation records for 'bar.acm-test.test-domain.in' to be created in zone Z67890.
132+
133+
Make sure the domain string passed to the `domain_hosted_zone_ids` exactly matches the domain string(s) set in `acm_tls_certificates`.
134+
108135
## Certificate Renewal and Expiration
109136

110137
If you use this module to create a new certificate, it should automatically renew so long as the following criteria are met at least 60 days prior to expiration:
@@ -205,7 +232,7 @@ In this example, the `acm-tls-certificates` module will "wait" until your `aws_r
205232
206233
module "acm_tls_certificate" {
207234
208-
source = "git::[email protected]:gruntwork-io/terraform-aws-load-balancer.git//modules/acm-tls-certificate?ref=v0.29.18"
235+
source = "git::[email protected]:gruntwork-io/terraform-aws-load-balancer.git//modules/acm-tls-certificate?ref=v0.29.19"
209236
210237
# ----------------------------------------------------------------------------------------------------
211238
# REQUIRED VARIABLES
@@ -263,7 +290,7 @@ module "acm_tls_certificate" {
263290
# ------------------------------------------------------------------------------------------------------
264291
265292
terraform {
266-
source = "git::[email protected]:gruntwork-io/terraform-aws-load-balancer.git//modules/acm-tls-certificate?ref=v0.29.18"
293+
source = "git::[email protected]:gruntwork-io/terraform-aws-load-balancer.git//modules/acm-tls-certificate?ref=v0.29.19"
267294
}
268295
269296
inputs = {
@@ -467,6 +494,23 @@ Map of domains to hosted zone IDs that can be used in place of looking up with a
467494

468495
</HclListItemDescription>
469496
<HclListItemDefaultValue defaultValue="{}"/>
497+
<HclGeneralListItem title="More Details">
498+
<details>
499+
500+
501+
```hcl
502+
503+
Example var usage:
504+
domain_hosted_zone_ids = {
505+
"*.foo.acm-test.test-domain.in" = "Z12345"
506+
"*.bar.acm-test.test-domain.in" = "Z67890"
507+
}
508+
509+
510+
```
511+
</details>
512+
513+
</HclGeneralListItem>
470514
</HclListItem>
471515

472516
<HclListItem name="global_tags" requirement="optional" type="map(string)">
@@ -500,11 +544,11 @@ Global tags to apply to all ACM certificates issued via this module. These globa
500544
<!-- ##DOCS-SOURCER-START
501545
{
502546
"originalSources": [
503-
"https://github.com/gruntwork-io/terraform-aws-load-balancer/tree/v0.29.18/modules/acm-tls-certificate/readme.md",
504-
"https://github.com/gruntwork-io/terraform-aws-load-balancer/tree/v0.29.18/modules/acm-tls-certificate/variables.tf",
505-
"https://github.com/gruntwork-io/terraform-aws-load-balancer/tree/v0.29.18/modules/acm-tls-certificate/outputs.tf"
547+
"https://github.com/gruntwork-io/terraform-aws-load-balancer/tree/v0.29.19/modules/acm-tls-certificate/readme.md",
548+
"https://github.com/gruntwork-io/terraform-aws-load-balancer/tree/v0.29.19/modules/acm-tls-certificate/variables.tf",
549+
"https://github.com/gruntwork-io/terraform-aws-load-balancer/tree/v0.29.19/modules/acm-tls-certificate/outputs.tf"
506550
],
507551
"sourcePlugin": "module-catalog-api",
508-
"hash": "f7d978a3c98a1acf0df9c2bcfbb0a759"
552+
"hash": "1b600e553a9c65c2e2762fdea851c045"
509553
}
510554
##DOCS-SOURCER-END -->

docs/reference/modules/terraform-aws-load-balancer/alb/alb.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,11 @@ import VersionBadge from '../../../../../src/components/VersionBadge.tsx';
99
import { HclListItem, HclListItemDescription, HclListItemTypeDetails, HclListItemDefaultValue, HclGeneralListItem } from '../../../../../src/components/HclListItem.tsx';
1010
import { ModuleUsage } from "../../../../../src/components/ModuleUsage";
1111

12-
<VersionBadge repoTitle="Load Balancer Modules" version="0.29.18" lastModifiedVersion="0.29.17"/>
12+
<VersionBadge repoTitle="Load Balancer Modules" version="0.29.19" lastModifiedVersion="0.29.17"/>
1313

1414
# Application Load Balancer (ALB) Module
1515

16-
<a href="https://github.com/gruntwork-io/terraform-aws-load-balancer/tree/v0.29.18/modules/alb" className="link-button" title="View the source code for this module in GitHub.">View Source</a>
16+
<a href="https://github.com/gruntwork-io/terraform-aws-load-balancer/tree/v0.29.19/modules/alb" className="link-button" title="View the source code for this module in GitHub.">View Source</a>
1717

1818
<a href="https://github.com/gruntwork-io/terraform-aws-load-balancer/releases/tag/v0.29.17" className="link-button" title="Release notes for only versions which impacted this module.">Release Notes</a>
1919

@@ -191,7 +191,7 @@ There are two ways for you to override this behavior:
191191
192192
module "alb" {
193193
194-
source = "git::[email protected]:gruntwork-io/terraform-aws-load-balancer.git//modules/alb?ref=v0.29.18"
194+
source = "git::[email protected]:gruntwork-io/terraform-aws-load-balancer.git//modules/alb?ref=v0.29.19"
195195
196196
# ----------------------------------------------------------------------------------------------------
197197
# REQUIRED VARIABLES
@@ -403,7 +403,7 @@ module "alb" {
403403
# ------------------------------------------------------------------------------------------------------
404404
405405
terraform {
406-
source = "git::[email protected]:gruntwork-io/terraform-aws-load-balancer.git//modules/alb?ref=v0.29.18"
406+
source = "git::[email protected]:gruntwork-io/terraform-aws-load-balancer.git//modules/alb?ref=v0.29.19"
407407
}
408408
409409
inputs = {
@@ -1105,11 +1105,11 @@ A map from port to the AWS ARNs of the listeners for the ALB that has been deplo
11051105
<!-- ##DOCS-SOURCER-START
11061106
{
11071107
"originalSources": [
1108-
"https://github.com/gruntwork-io/terraform-aws-load-balancer/tree/v0.29.18/modules/alb/readme.md",
1109-
"https://github.com/gruntwork-io/terraform-aws-load-balancer/tree/v0.29.18/modules/alb/variables.tf",
1110-
"https://github.com/gruntwork-io/terraform-aws-load-balancer/tree/v0.29.18/modules/alb/outputs.tf"
1108+
"https://github.com/gruntwork-io/terraform-aws-load-balancer/tree/v0.29.19/modules/alb/readme.md",
1109+
"https://github.com/gruntwork-io/terraform-aws-load-balancer/tree/v0.29.19/modules/alb/variables.tf",
1110+
"https://github.com/gruntwork-io/terraform-aws-load-balancer/tree/v0.29.19/modules/alb/outputs.tf"
11111111
],
11121112
"sourcePlugin": "module-catalog-api",
1113-
"hash": "db370048e8189ac505d1680204197c3c"
1113+
"hash": "558d65b36a69a3769f57d8b5447372c8"
11141114
}
11151115
##DOCS-SOURCER-END -->

docs/reference/modules/terraform-aws-load-balancer/lb-listener-rules/lb-listener-rules.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,11 @@ import VersionBadge from '../../../../../src/components/VersionBadge.tsx';
99
import { HclListItem, HclListItemDescription, HclListItemTypeDetails, HclListItemDefaultValue, HclGeneralListItem } from '../../../../../src/components/HclListItem.tsx';
1010
import { ModuleUsage } from "../../../../../src/components/ModuleUsage";
1111

12-
<VersionBadge repoTitle="Load Balancer Modules" version="0.29.18" lastModifiedVersion="0.29.16"/>
12+
<VersionBadge repoTitle="Load Balancer Modules" version="0.29.19" lastModifiedVersion="0.29.16"/>
1313

1414
# Load Balancer Listener Rules
1515

16-
<a href="https://github.com/gruntwork-io/terraform-aws-load-balancer/tree/v0.29.18/modules/lb-listener-rules" className="link-button" title="View the source code for this module in GitHub.">View Source</a>
16+
<a href="https://github.com/gruntwork-io/terraform-aws-load-balancer/tree/v0.29.19/modules/lb-listener-rules" className="link-button" title="View the source code for this module in GitHub.">View Source</a>
1717

1818
<a href="https://github.com/gruntwork-io/terraform-aws-load-balancer/releases/tag/v0.29.16" className="link-button" title="Release notes for only versions which impacted this module.">Release Notes</a>
1919

@@ -95,7 +95,7 @@ Note that in most cases, your path definitions should be mutually exclusive and
9595
9696
module "lb_listener_rules" {
9797
98-
source = "git::[email protected]:gruntwork-io/terraform-aws-load-balancer.git//modules/lb-listener-rules?ref=v0.29.18"
98+
source = "git::[email protected]:gruntwork-io/terraform-aws-load-balancer.git//modules/lb-listener-rules?ref=v0.29.19"
9999
100100
# ----------------------------------------------------------------------------------------------------
101101
# REQUIRED VARIABLES
@@ -146,7 +146,7 @@ module "lb_listener_rules" {
146146
# ------------------------------------------------------------------------------------------------------
147147
148148
terraform {
149-
source = "git::[email protected]:gruntwork-io/terraform-aws-load-balancer.git//modules/lb-listener-rules?ref=v0.29.18"
149+
source = "git::[email protected]:gruntwork-io/terraform-aws-load-balancer.git//modules/lb-listener-rules?ref=v0.29.19"
150150
}
151151
152152
inputs = {
@@ -808,11 +808,11 @@ The ARNs of the rules of type redirect. The key is the same key of the rule from
808808
<!-- ##DOCS-SOURCER-START
809809
{
810810
"originalSources": [
811-
"https://github.com/gruntwork-io/terraform-aws-load-balancer/tree/v0.29.18/modules/lb-listener-rules/readme.md",
812-
"https://github.com/gruntwork-io/terraform-aws-load-balancer/tree/v0.29.18/modules/lb-listener-rules/variables.tf",
813-
"https://github.com/gruntwork-io/terraform-aws-load-balancer/tree/v0.29.18/modules/lb-listener-rules/outputs.tf"
811+
"https://github.com/gruntwork-io/terraform-aws-load-balancer/tree/v0.29.19/modules/lb-listener-rules/readme.md",
812+
"https://github.com/gruntwork-io/terraform-aws-load-balancer/tree/v0.29.19/modules/lb-listener-rules/variables.tf",
813+
"https://github.com/gruntwork-io/terraform-aws-load-balancer/tree/v0.29.19/modules/lb-listener-rules/outputs.tf"
814814
],
815815
"sourcePlugin": "module-catalog-api",
816-
"hash": "4da7baa42071b999c9d67797544ef78c"
816+
"hash": "ea024dcf8743ac98b9e5335294115cff"
817817
}
818818
##DOCS-SOURCER-END -->

docs/reference/modules/terraform-aws-load-balancer/nlb/nlb.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,11 @@ import VersionBadge from '../../../../../src/components/VersionBadge.tsx';
99
import { HclListItem, HclListItemDescription, HclListItemTypeDetails, HclListItemDefaultValue, HclGeneralListItem } from '../../../../../src/components/HclListItem.tsx';
1010
import { ModuleUsage } from "../../../../../src/components/ModuleUsage";
1111

12-
<VersionBadge repoTitle="Load Balancer Modules" version="0.29.18" lastModifiedVersion="0.23.0"/>
12+
<VersionBadge repoTitle="Load Balancer Modules" version="0.29.19" lastModifiedVersion="0.23.0"/>
1313

1414
# Network Load Balancer (NLB) Module
1515

16-
<a href="https://github.com/gruntwork-io/terraform-aws-load-balancer/tree/v0.29.18/modules/nlb" className="link-button" title="View the source code for this module in GitHub.">View Source</a>
16+
<a href="https://github.com/gruntwork-io/terraform-aws-load-balancer/tree/v0.29.19/modules/nlb" className="link-button" title="View the source code for this module in GitHub.">View Source</a>
1717

1818
<a href="https://github.com/gruntwork-io/terraform-aws-load-balancer/releases/tag/v0.23.0" className="link-button" title="Release notes for only versions which impacted this module.">Release Notes</a>
1919

@@ -29,11 +29,11 @@ For information on why the module was removed, refer to the discussion in [PR
2929
<!-- ##DOCS-SOURCER-START
3030
{
3131
"originalSources": [
32-
"https://github.com/gruntwork-io/terraform-aws-load-balancer/tree/v0.29.18/modules/nlb/readme.md",
33-
"https://github.com/gruntwork-io/terraform-aws-load-balancer/tree/v0.29.18/modules/nlb/variables.tf",
34-
"https://github.com/gruntwork-io/terraform-aws-load-balancer/tree/v0.29.18/modules/nlb/outputs.tf"
32+
"https://github.com/gruntwork-io/terraform-aws-load-balancer/tree/v0.29.19/modules/nlb/readme.md",
33+
"https://github.com/gruntwork-io/terraform-aws-load-balancer/tree/v0.29.19/modules/nlb/variables.tf",
34+
"https://github.com/gruntwork-io/terraform-aws-load-balancer/tree/v0.29.19/modules/nlb/outputs.tf"
3535
],
3636
"sourcePlugin": "module-catalog-api",
37-
"hash": "5a7d474ec29070fc25418ed51d71565e"
37+
"hash": "211c686bc1cb1ab97f8e5ccb8e72943d"
3838
}
3939
##DOCS-SOURCER-END -->

0 commit comments

Comments
 (0)