Skip to content

docs: update note on conflict between aws_route and aws_route_table #44547

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
Merged
merged 3 commits into from
Oct 8, 2025
Merged

docs: update note on conflict between aws_route and aws_route_table #44547

merged 3 commits into from
Oct 8, 2025

Conversation

stefanfreitag
Copy link
Contributor

@stefanfreitag stefanfreitag commented Oct 5, 2025 •
edited
Loading

Rollback Plan

If a change needs to be reverted, we will publish an updated version of the library.

Changes to Security Controls

No changes to security controls are implemented.

Description

Minor update to the notes for aws_route and aws_route_table.

In the updated version of the notes

  • the specific resource names are mentioned, e.g aws_route vs. Route

  • the one in the aws_route_table docs is moved next to the argument route
    I needed to update the indentation level of the note to level 0, as level 1 (indentation using 2 spaces) gave an error when running tfproviderdocs

    Error checking Terraform Provider documentation: 1 error occurred:
      * website/docs/r/route_table.html.markdown: error checking file contents: arguments section does not contain an Optional region argument

Relations

Closes #44530

References

Output from Acceptance Testing

Not applicable. Only documentation is updated.

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Oct 5, 2025

Community Guidelines

This comment is added to every new Pull Request to provide quick reference to how the Terraform AWS Provider is maintained. Please review the information below, and thank you for contributing to the community that keeps the provider thriving! 🚀

Voting for Prioritization

  • Please vote on this Pull Request by adding a 👍 reaction to the original post to help the community and maintainers prioritize it.
  • Please see our prioritization guide for additional information on how the maintainers handle prioritization.
  • Please do not leave +1 or other comments that do not add relevant new information or questions; they generate extra noise for others following the Pull Request and do not help prioritize the request.

Pull Request Authors

  • Review the contribution guide relating to the type of change you are making to ensure all of the necessary steps have been taken.
  • Whether or not the branch has been rebased will not impact prioritization, but doing so is always a welcome surprise.

@github-actions github-actions bot added needs-triage Waiting for first response or review from a maintainer. documentation Introduces or discusses updates to documentation. service/vpc Issues and PRs that pertain to the vpc service. size/XS Managed by automation to categorize the size of a PR. external-maintainer Contribution from a trusted external contributor. labels Oct 5, 2025
@EugenKon
Copy link

EugenKon commented Oct 6, 2025

Thanks for preparing that. A few notices:

  1. Please do not remove link to aws_route_table

  2. Add link to aws_route

  3. At this time you cannot use a aws_route_table in conjunction with any aws_route resources.

    I can use aws_route_table in conjunction with any aws_route resources. Please reword your sentence explicitly that "aws_route_table inline block route can not be used in conjunction with aws_route resource".

@stefanfreitag
docs: clarifies route and route table usage
b65fdea 
Clarifies that using inline route blocks within `aws_route_table` in conjunction with `aws_route` resources causes conflicts.
@stefanfreitag stefanfreitag marked this pull request as ready for review October 8, 2025 14:18
@stefanfreitag stefanfreitag requested a review from a team as a code owner October 8, 2025 14:19
EugenKon
EugenKon reviewed Oct 8, 2025
View reviewed changes
ewbankkit
ewbankkit approved these changes Oct 8, 2025
View reviewed changes
Copy link
Contributor

@ewbankkit ewbankkit left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 🚀.

@ewbankkit ewbankkit removed the needs-triage Waiting for first response or review from a maintainer. label Oct 8, 2025
@ewbankkit
Copy link
Contributor

@stefanfreitag Thanks for the contribution 🎉 👏.

@ewbankkit ewbankkit merged commit e305197 into hashicorp:main Oct 8, 2025
25 checks passed
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Oct 8, 2025

Warning

This Issue has been closed, meaning that any additional comments are much easier for the maintainers to miss. Please assume that the maintainers will not see them.

Ongoing conversations amongst community members are welcome, however, the issue will be locked after 30 days. Moving conversations to another venue, such as the AWS Provider forum, is recommended. If you have additional concerns, please open a new issue, referencing this one where needed.

@github-actions github-actions bot added this to the v6.16.0 milestone Oct 8, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ewbankkit ewbankkit ewbankkit approved these changes

+1 more reviewer

@EugenKon EugenKon EugenKon left review comments

Reviewers whose approvals may not affect merge requirements
Assignees
No one assigned
Labels
documentation Introduces or discusses updates to documentation. external-maintainer Contribution from a trusted external contributor. service/vpc Issues and PRs that pertain to the vpc service. size/XS Managed by automation to categorize the size of a PR.
Projects
None yet
Milestone
v6.16.0
Development

Successfully merging this pull request may close these issues.

route resource and inline block route
3 participants
@stefanfreitag @EugenKon @ewbankkit