Skip to content

docs: Clarify NAT gateway behavior and precedence of single_nat_gateway vs one_nat_gateway_per_az #1214

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.

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

Trish-Muyambiri
Copy link

Summary

This PR improves the documentation around NAT Gateway configurations by clearly outlining the behavior of:

  • single_nat_gateway
  • one_nat_gateway_per_az
  • Their interaction and precedence when both are enabled

What Changed

  • Updated the NAT Gateway config section in README.md to:
    • Use consistent bullet formatting
    • Include clear, labeled scenarios
    • Add a visible note explaining precedence when both flags are set
  • Removed a redundant sentence that was covered by the new warning block

Why

This helps users understand how NAT Gateway settings affect behavior in common setups, especially when optimizing for cost or availability.

Closes #1196

@Trish-Muyambiri Trish-Muyambiri force-pushed the docs/clarify-nat-gateway-behavior branch from fcbd4db to d125bb8 Compare June 28, 2025 16:06
@Trish-Muyambiri Trish-Muyambiri changed the title docs: clarify NAT gateway behavior and precedence of single_nat_gateway vs one_nat_gateway_per_az docs: Clarify NAT gateway behavior and precedence of single_nat_gateway vs one_nat_gateway_per_az Jun 28, 2025
@Trish-Muyambiri Trish-Muyambiri force-pushed the docs/clarify-nat-gateway-behavior branch from d125bb8 to 5a006fe Compare June 28, 2025 16:33
@Trish-Muyambiri Trish-Muyambiri force-pushed the docs/clarify-nat-gateway-behavior branch from 5a006fe to 2484ef3 Compare June 29, 2025 07:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

One NAT per subnet docs update or code fix ?
1 participant