Skip to content

Commit e9fa6d5

Browse files
authored
update vpc module docs (#1057)
* update vpc module docs
1 parent dd8a27b commit e9fa6d5

File tree

20 files changed

+188
-188
lines changed

20 files changed

+188
-188
lines changed

docs/reference/modules/terraform-aws-vpc/network-acl-inbound/network-acl-inbound.md

Lines changed: 9 additions & 9 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="VPC Modules" version="0.26.2" lastModifiedVersion="0.22.3"/>
12+
<VersionBadge repoTitle="VPC Modules" version="0.26.4" lastModifiedVersion="0.22.3"/>
1313

1414
# Network ACL Inbound Terraform Module
1515

16-
<a href="https://github.com/gruntwork-io/terraform-aws-vpc/tree/v0.26.2/modules/network-acl-inbound" 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-vpc/tree/v0.26.4/modules/network-acl-inbound" 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-vpc/releases/tag/v0.22.3" className="link-button" title="Release notes for only versions which impacted this module.">Release Notes</a>
1919

@@ -24,7 +24,7 @@ with because they are stateless, which means that opening an inbound port is oft
2424
which your services use to respond. This can be very easy to forget, so this module adds not only the inbound ports to
2525
an ACL, but also the ephemeral outbound ports for return traffic.
2626

27-
See the [network-acl-outbound](https://github.com/gruntwork-io/terraform-aws-vpc/tree/v0.26.2/modules/network-acl-outbound) module for the analogous version of this module, but for opening
27+
See the [network-acl-outbound](https://github.com/gruntwork-io/terraform-aws-vpc/tree/v0.26.4/modules/network-acl-outbound) module for the analogous version of this module, but for opening
2828
outbound ports.
2929

3030
## What's a Network ACL?
@@ -47,7 +47,7 @@ EC2 instance), a network ACL controls what inbound and outbound traffic is allow
4747
4848
module "network_acl_inbound" {
4949
50-
source = "git::[email protected]:gruntwork-io/terraform-aws-vpc.git//modules/network-acl-inbound?ref=v0.26.2"
50+
source = "git::[email protected]:gruntwork-io/terraform-aws-vpc.git//modules/network-acl-inbound?ref=v0.26.4"
5151
5252
# ----------------------------------------------------------------------------------------------------
5353
# REQUIRED VARIABLES
@@ -134,7 +134,7 @@ module "network_acl_inbound" {
134134
# ------------------------------------------------------------------------------------------------------
135135
136136
terraform {
137-
source = "git::[email protected]:gruntwork-io/terraform-aws-vpc.git//modules/network-acl-inbound?ref=v0.26.2"
137+
source = "git::[email protected]:gruntwork-io/terraform-aws-vpc.git//modules/network-acl-inbound?ref=v0.26.4"
138138
}
139139
140140
inputs = {
@@ -221,11 +221,11 @@ inputs = {
221221
<!-- ##DOCS-SOURCER-START
222222
{
223223
"originalSources": [
224-
"https://github.com/gruntwork-io/terraform-aws-vpc/tree/v0.26.2/modules/network-acl-inbound/readme.md",
225-
"https://github.com/gruntwork-io/terraform-aws-vpc/tree/v0.26.2/modules/network-acl-inbound/variables.tf",
226-
"https://github.com/gruntwork-io/terraform-aws-vpc/tree/v0.26.2/modules/network-acl-inbound/outputs.tf"
224+
"https://github.com/gruntwork-io/terraform-aws-vpc/tree/v0.26.4/modules/network-acl-inbound/readme.md",
225+
"https://github.com/gruntwork-io/terraform-aws-vpc/tree/v0.26.4/modules/network-acl-inbound/variables.tf",
226+
"https://github.com/gruntwork-io/terraform-aws-vpc/tree/v0.26.4/modules/network-acl-inbound/outputs.tf"
227227
],
228228
"sourcePlugin": "module-catalog-api",
229-
"hash": "0400400ceef81805cf9ff8e84ebe11a1"
229+
"hash": "2accefc8c8af8cc2d329c6adbfdca971"
230230
}
231231
##DOCS-SOURCER-END -->

docs/reference/modules/terraform-aws-vpc/network-acl-outbound/network-acl-outbound.md

Lines changed: 9 additions & 9 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="VPC Modules" version="0.26.2" lastModifiedVersion="0.22.3"/>
12+
<VersionBadge repoTitle="VPC Modules" version="0.26.4" lastModifiedVersion="0.22.3"/>
1313

1414
# Network ACL Outbound Terraform Module
1515

16-
<a href="https://github.com/gruntwork-io/terraform-aws-vpc/tree/v0.26.2/modules/network-acl-outbound" 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-vpc/tree/v0.26.4/modules/network-acl-outbound" 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-vpc/releases/tag/v0.22.3" className="link-button" title="Release notes for only versions which impacted this module.">Release Notes</a>
1919

@@ -24,7 +24,7 @@ because they are stateless, which means that opening an outbound port is often n
2424
which the remote services can use to respond. This can be very easy to forget, so this module adds not only the
2525
outbound to an ACL, but also the ephemeral inbound ports for return traffic.
2626

27-
See the [network-acl-inbound](https://github.com/gruntwork-io/terraform-aws-vpc/tree/v0.26.2/modules/network-acl-inbound) module for the analogous version of this module, but for opening
27+
See the [network-acl-inbound](https://github.com/gruntwork-io/terraform-aws-vpc/tree/v0.26.4/modules/network-acl-inbound) module for the analogous version of this module, but for opening
2828
inbound ports.
2929

3030
## What's a Network ACL?
@@ -47,7 +47,7 @@ EC2 instance), a network ACL controls what inbound and outbound traffic is allow
4747
4848
module "network_acl_outbound" {
4949
50-
source = "git::[email protected]:gruntwork-io/terraform-aws-vpc.git//modules/network-acl-outbound?ref=v0.26.2"
50+
source = "git::[email protected]:gruntwork-io/terraform-aws-vpc.git//modules/network-acl-outbound?ref=v0.26.4"
5151
5252
# ----------------------------------------------------------------------------------------------------
5353
# REQUIRED VARIABLES
@@ -134,7 +134,7 @@ module "network_acl_outbound" {
134134
# ------------------------------------------------------------------------------------------------------
135135
136136
terraform {
137-
source = "git::[email protected]:gruntwork-io/terraform-aws-vpc.git//modules/network-acl-outbound?ref=v0.26.2"
137+
source = "git::[email protected]:gruntwork-io/terraform-aws-vpc.git//modules/network-acl-outbound?ref=v0.26.4"
138138
}
139139
140140
inputs = {
@@ -221,11 +221,11 @@ inputs = {
221221
<!-- ##DOCS-SOURCER-START
222222
{
223223
"originalSources": [
224-
"https://github.com/gruntwork-io/terraform-aws-vpc/tree/v0.26.2/modules/network-acl-outbound/readme.md",
225-
"https://github.com/gruntwork-io/terraform-aws-vpc/tree/v0.26.2/modules/network-acl-outbound/variables.tf",
226-
"https://github.com/gruntwork-io/terraform-aws-vpc/tree/v0.26.2/modules/network-acl-outbound/outputs.tf"
224+
"https://github.com/gruntwork-io/terraform-aws-vpc/tree/v0.26.4/modules/network-acl-outbound/readme.md",
225+
"https://github.com/gruntwork-io/terraform-aws-vpc/tree/v0.26.4/modules/network-acl-outbound/variables.tf",
226+
"https://github.com/gruntwork-io/terraform-aws-vpc/tree/v0.26.4/modules/network-acl-outbound/outputs.tf"
227227
],
228228
"sourcePlugin": "module-catalog-api",
229-
"hash": "a4596544f00ceb7d8c6cdae8de7679c6"
229+
"hash": "2e12bec9117a0c05586d973caec90828"
230230
}
231231
##DOCS-SOURCER-END -->

docs/reference/modules/terraform-aws-vpc/port-range-calculator/port-range-calculator.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="VPC Modules" version="0.26.2" lastModifiedVersion="0.22.3"/>
12+
<VersionBadge repoTitle="VPC Modules" version="0.26.4" lastModifiedVersion="0.22.3"/>
1313

1414
# Port Calculator Module
1515

16-
<a href="https://github.com/gruntwork-io/terraform-aws-vpc/tree/v0.26.2/modules/port-range-calculator" 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-vpc/tree/v0.26.4/modules/port-range-calculator" 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-vpc/releases/tag/v0.22.3" className="link-button" title="Release notes for only versions which impacted this module.">Release Notes</a>
1919

@@ -50,7 +50,7 @@ just those ports:
5050
5151
module "port_range_calculator" {
5252
53-
source = "git::[email protected]:gruntwork-io/terraform-aws-vpc.git//modules/port-range-calculator?ref=v0.26.2"
53+
source = "git::[email protected]:gruntwork-io/terraform-aws-vpc.git//modules/port-range-calculator?ref=v0.26.4"
5454
5555
# ----------------------------------------------------------------------------------------------------
5656
# REQUIRED VARIABLES
@@ -84,7 +84,7 @@ module "port_range_calculator" {
8484
# ------------------------------------------------------------------------------------------------------
8585
8686
terraform {
87-
source = "git::[email protected]:gruntwork-io/terraform-aws-vpc.git//modules/port-range-calculator?ref=v0.26.2"
87+
source = "git::[email protected]:gruntwork-io/terraform-aws-vpc.git//modules/port-range-calculator?ref=v0.26.4"
8888
}
8989
9090
inputs = {
@@ -178,11 +178,11 @@ Map of port ranges to the ranges to allow. This is provided as a convenience out
178178
<!-- ##DOCS-SOURCER-START
179179
{
180180
"originalSources": [
181-
"https://github.com/gruntwork-io/terraform-aws-vpc/tree/v0.26.2/modules/port-range-calculator/readme.md",
182-
"https://github.com/gruntwork-io/terraform-aws-vpc/tree/v0.26.2/modules/port-range-calculator/variables.tf",
183-
"https://github.com/gruntwork-io/terraform-aws-vpc/tree/v0.26.2/modules/port-range-calculator/outputs.tf"
181+
"https://github.com/gruntwork-io/terraform-aws-vpc/tree/v0.26.4/modules/port-range-calculator/readme.md",
182+
"https://github.com/gruntwork-io/terraform-aws-vpc/tree/v0.26.4/modules/port-range-calculator/variables.tf",
183+
"https://github.com/gruntwork-io/terraform-aws-vpc/tree/v0.26.4/modules/port-range-calculator/outputs.tf"
184184
],
185185
"sourcePlugin": "module-catalog-api",
186-
"hash": "7874e2b80edb6cac93a2c7659a3c5693"
186+
"hash": "ed65b2baabc8cc77e683221c0c878b8d"
187187
}
188188
##DOCS-SOURCER-END -->

docs/reference/modules/terraform-aws-vpc/transit-gateway-attachment/transit-gateway-attachment.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -9,27 +9,27 @@ 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="VPC Modules" version="0.26.2" lastModifiedVersion="0.26.2"/>
12+
<VersionBadge repoTitle="VPC Modules" version="0.26.4" lastModifiedVersion="0.26.2"/>
1313

1414
# Transit Gateway Attachment Terraform Module
1515

16-
<a href="https://github.com/gruntwork-io/terraform-aws-vpc/tree/v0.26.2/modules/transit-gateway-attachment" 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-vpc/tree/v0.26.4/modules/transit-gateway-attachment" 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-vpc/releases/tag/v0.26.2" className="link-button" title="Release notes for only versions which impacted this module.">Release Notes</a>
1919

2020
This module creates a transit gateway attachment resource. A transit gateway attachment, attaches the transit gateway to a VPC. This module can be used to attach a transit gateway to multiple VPCs. Attaching a transit gateway to one or more VPCs creates a HUB and spoke routing topology, allowing traffic from one VPC to reach other VPCs or from a VPC to reach on-premises networks.
2121

2222
The module accepts a map of VPCs for attachment to the transit gateway. See the examples below for the structure of the map.
2323

24-
See [VPC Core Concepts](https://github.com/gruntwork-io/terraform-aws-vpc/tree/v0.26.2/modules//_docs/vpc-core-concepts.md) for more information on the core networking components and topologies.
24+
See [VPC Core Concepts](https://github.com/gruntwork-io/terraform-aws-vpc/tree/v0.26.4/modules//_docs/vpc-core-concepts.md) for more information on the core networking components and topologies.
2525

2626
## What is a Transit Gateway Attachment?
2727

2828
A transit gateway attachment is a way to connect a transit gateway (virtual router) to a VPC. You can think of a VPC attachment just like a cat5e or cat6 network cable. By attaching the transit gateway, you're connecting the cable between the virtual router and a VPC. By attaching the transit gateway and then either configuring a route or enabling route propagation, you can route traffic between VPCs.
2929

3030
## Usage
3131

32-
For usage examples, check out the [examples folder](https://github.com/gruntwork-io/terraform-aws-vpc/tree/v0.26.2/examples/transit-gateway-attachment/).
32+
For usage examples, check out the [examples folder](https://github.com/gruntwork-io/terraform-aws-vpc/tree/v0.26.4/examples/transit-gateway-attachment/).
3333

3434
<!-- BEGIN_TF_DOCS -->
3535

@@ -90,7 +90,7 @@ No modules.
9090
9191
module "transit_gateway_attachment" {
9292
93-
source = "git::[email protected]:gruntwork-io/terraform-aws-vpc.git//modules/transit-gateway-attachment?ref=v0.26.2"
93+
source = "git::[email protected]:gruntwork-io/terraform-aws-vpc.git//modules/transit-gateway-attachment?ref=v0.26.4"
9494
9595
# ----------------------------------------------------------------------------------------------------
9696
# REQUIRED VARIABLES
@@ -156,7 +156,7 @@ module "transit_gateway_attachment" {
156156
# ------------------------------------------------------------------------------------------------------
157157
158158
terraform {
159-
source = "git::[email protected]:gruntwork-io/terraform-aws-vpc.git//modules/transit-gateway-attachment?ref=v0.26.2"
159+
source = "git::[email protected]:gruntwork-io/terraform-aws-vpc.git//modules/transit-gateway-attachment?ref=v0.26.4"
160160
}
161161
162162
inputs = {
@@ -329,11 +329,11 @@ EC2 Transit Gateway Attachment identifier.
329329
<!-- ##DOCS-SOURCER-START
330330
{
331331
"originalSources": [
332-
"https://github.com/gruntwork-io/terraform-aws-vpc/tree/v0.26.2/modules/transit-gateway-attachment/readme.md",
333-
"https://github.com/gruntwork-io/terraform-aws-vpc/tree/v0.26.2/modules/transit-gateway-attachment/variables.tf",
334-
"https://github.com/gruntwork-io/terraform-aws-vpc/tree/v0.26.2/modules/transit-gateway-attachment/outputs.tf"
332+
"https://github.com/gruntwork-io/terraform-aws-vpc/tree/v0.26.4/modules/transit-gateway-attachment/readme.md",
333+
"https://github.com/gruntwork-io/terraform-aws-vpc/tree/v0.26.4/modules/transit-gateway-attachment/variables.tf",
334+
"https://github.com/gruntwork-io/terraform-aws-vpc/tree/v0.26.4/modules/transit-gateway-attachment/outputs.tf"
335335
],
336336
"sourcePlugin": "module-catalog-api",
337-
"hash": "c1d60f14044e9595d9f5dc661c5782d6"
337+
"hash": "9d1d61b0d2d4b5c259ead9b3ebe8baf2"
338338
}
339339
##DOCS-SOURCER-END -->

docs/reference/modules/terraform-aws-vpc/transit-gateway-peering-attachment-accepter/transit-gateway-peering-attachment-accepter.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -9,23 +9,23 @@ 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="VPC Modules" version="0.26.2" lastModifiedVersion="0.26.2"/>
12+
<VersionBadge repoTitle="VPC Modules" version="0.26.4" lastModifiedVersion="0.26.2"/>
1313

1414
# Transit Gateway Peering Attachment Accepter Accepter Terraform Module
1515

16-
<a href="https://github.com/gruntwork-io/terraform-aws-vpc/tree/v0.26.2/modules/transit-gateway-peering-attachment-accepter" 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-vpc/tree/v0.26.4/modules/transit-gateway-peering-attachment-accepter" 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-vpc/releases/tag/v0.26.2" className="link-button" title="Release notes for only versions which impacted this module.">Release Notes</a>
1919

2020
This Terraform Module creates Transit Gateway peering resources for the `accepter` side of the connection. This allows for connectivity between multiple regions or multiple AWS accounts. Transit Gateway peering is a one-to-one relationship between two transit gateways. If you need to peer multiple transit gateways, you will need to create multiple transit gateway peering attachments.
2121

22-
See [VPC Core Concepts](https://github.com/gruntwork-io/terraform-aws-vpc/tree/v0.26.2/modules//_docs/vpc-core-concepts.md) for more information on the core networking components and topologies.
22+
See [VPC Core Concepts](https://github.com/gruntwork-io/terraform-aws-vpc/tree/v0.26.4/modules//_docs/vpc-core-concepts.md) for more information on the core networking components and topologies.
2323

2424
## What is a Transit Gateway Peering Attachment Accepter?
2525

2626
A transit gateway peering attachment accepter is a way to connect two transit gateways to each other. Much like the VPC attachment, this can be thought of as a network cable. By attaching them, you 'plug' the two transit gateways together. This allows you to route traffic between the two transit gateways. Unlike VPC attachments, peering attachments have two components to the attachment a `requester` and an `accepter`. This is important because each attachment must be accepted prior to the attachment being completed. This is a security measure to ensure a malicious attachment from a random account does not gain network access to your environment. The `accepter` is the side of the peering attachment that accepts the request from the `requester`.
2727

28-
For usage examples, check out the [examples folder](https://github.com/gruntwork-io/terraform-aws-vpc/tree/v0.26.2/examples/transit-gateway-peering-attachment).
28+
For usage examples, check out the [examples folder](https://github.com/gruntwork-io/terraform-aws-vpc/tree/v0.26.4/examples/transit-gateway-peering-attachment).
2929

3030
<!-- BEGIN_TF_DOCS -->
3131

@@ -86,7 +86,7 @@ No modules.
8686
8787
module "transit_gateway_peering_attachment_accepter" {
8888
89-
source = "git::[email protected]:gruntwork-io/terraform-aws-vpc.git//modules/transit-gateway-peering-attachment-accepter?ref=v0.26.2"
89+
source = "git::[email protected]:gruntwork-io/terraform-aws-vpc.git//modules/transit-gateway-peering-attachment-accepter?ref=v0.26.4"
9090
9191
# ----------------------------------------------------------------------------------------------------
9292
# REQUIRED VARIABLES
@@ -130,7 +130,7 @@ module "transit_gateway_peering_attachment_accepter" {
130130
# ------------------------------------------------------------------------------------------------------
131131
132132
terraform {
133-
source = "git::[email protected]:gruntwork-io/terraform-aws-vpc.git//modules/transit-gateway-peering-attachment-accepter?ref=v0.26.2"
133+
source = "git::[email protected]:gruntwork-io/terraform-aws-vpc.git//modules/transit-gateway-peering-attachment-accepter?ref=v0.26.4"
134134
}
135135
136136
inputs = {
@@ -259,11 +259,11 @@ The identifer of the transit gateway for the accepter resources.
259259
<!-- ##DOCS-SOURCER-START
260260
{
261261
"originalSources": [
262-
"https://github.com/gruntwork-io/terraform-aws-vpc/tree/v0.26.2/modules/transit-gateway-peering-attachment-accepter/readme.md",
263-
"https://github.com/gruntwork-io/terraform-aws-vpc/tree/v0.26.2/modules/transit-gateway-peering-attachment-accepter/variables.tf",
264-
"https://github.com/gruntwork-io/terraform-aws-vpc/tree/v0.26.2/modules/transit-gateway-peering-attachment-accepter/outputs.tf"
262+
"https://github.com/gruntwork-io/terraform-aws-vpc/tree/v0.26.4/modules/transit-gateway-peering-attachment-accepter/readme.md",
263+
"https://github.com/gruntwork-io/terraform-aws-vpc/tree/v0.26.4/modules/transit-gateway-peering-attachment-accepter/variables.tf",
264+
"https://github.com/gruntwork-io/terraform-aws-vpc/tree/v0.26.4/modules/transit-gateway-peering-attachment-accepter/outputs.tf"
265265
],
266266
"sourcePlugin": "module-catalog-api",
267-
"hash": "c62fca08d9ac448892adeeeac3caffc5"
267+
"hash": "546874432eceee34bc8cbb2ed177bfa9"
268268
}
269269
##DOCS-SOURCER-END -->

0 commit comments

Comments
 (0)