Skip to content

Commit e305197

Browse files
authored
Merge pull request #44547 from stefanfreitag/d-aws_route-update-note
docs: update note on conflict between aws_route and aws_route_table
2 parents 3701696 + b65fdea commit e305197

File tree

2 files changed

+4
-7
lines changed

2 files changed

+4
-7
lines changed

website/docs/r/route.html.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ description: |-
1010

1111
Provides a resource to create a routing table entry (a route) in a VPC routing table.
1212

13-
~> **NOTE on Route Tables and Routes:** Terraform currently provides both a standalone Route resource and a [Route Table](route_table.html) resource with routes defined in-line. At this time you cannot use a Route Table with in-line routes in conjunction with any Route resources. Doing so will cause a conflict of rule settings and will overwrite rules.
13+
~> **NOTE on Route Tables and Routes:** Terraform currently provides both a standalone Route resource ([`aws_route`](route.html)) and a Route Table resource with routes defined in-line ([`aws_route_table`](route_table.html)). At this time you cannot use a [`aws_route_table`](route_table.html) inline `route` blocks in conjunction with any [`aws_route`](route.html) resources. Doing so will cause a conflict of rule settings and will overwrite rules.
1414

1515
~> **NOTE on `gateway_id` attribute:** The AWS API is very forgiving with the resource ID passed in the `gateway_id` attribute. For example an `aws_route` resource can be created with an [`aws_nat_gateway`](nat_gateway.html) or [`aws_egress_only_internet_gateway`](egress_only_internet_gateway.html) ID specified for the `gateway_id` attribute. Specifying anything other than an [`aws_internet_gateway`](internet_gateway.html) or [`aws_vpn_gateway`](vpn_gateway.html) ID will lead to Terraform reporting a permanent diff between your configuration and recorded state, as the AWS API returns the more-specific attribute. If you are experiencing constant diffs with an `aws_route` resource, the first thing to check is that the correct attribute is being specified.
1616

website/docs/r/route_table.html.markdown

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,6 @@ description: |-
1010

1111
Provides a resource to create a VPC routing table.
1212

13-
~> **NOTE on Route Tables and Routes:** Terraform currently
14-
provides both a standalone [Route resource](route.html) and a Route Table resource with routes
15-
defined in-line. At this time you cannot use a Route Table with in-line routes
16-
in conjunction with any Route resources. Doing so will cause
17-
a conflict of rule settings and will overwrite rules.
18-
1913
~> **NOTE on `gateway_id` and `nat_gateway_id`:** The AWS API is very forgiving with these two
2014
attributes and the `aws_route_table` resource can be created with a NAT ID specified as a Gateway ID attribute.
2115
This _will_ lead to a permanent diff between your configuration and statefile, as the API returns the correct
@@ -125,6 +119,9 @@ This resource supports the following arguments:
125119
* `vpc_id` - (Required) The VPC ID.
126120
* `route` - (Optional) A list of route objects. Their keys are documented below. This argument is processed in [attribute-as-blocks mode](https://www.terraform.io/docs/configuration/attr-as-blocks.html).
127121
This means that omitting this argument is interpreted as ignoring any existing routes. To remove all managed routes an empty list should be specified. See the example above.
122+
123+
~> **NOTE on Route Tables and Routes:** Terraform currently provides both a standalone Route resource ([`aws_route`](route.html)) and a Route Table resource with routes defined in-line ([`aws_route_table`](route_table.html)). At this time you cannot use a [`aws_route_table`](route_table.html) inline `route` blocks in conjunction with any [`aws_route`](route.html) resources. Doing so will cause a conflict of rule settings and will overwrite rules.
124+
128125
* `tags` - (Optional) A map of tags to assign to the resource. If configured with a provider [`default_tags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level.
129126
* `propagating_vgws` - (Optional) A list of virtual gateways for propagation.
130127

0 commit comments

Comments
 (0)