Skip to content

docs: clarify availability_zones requirement for Multi-AZ DB clusters in aws_rds_cluster#46940

Merged
ewbankkit merged 2 commits intohashicorp:mainfrom
22skyy:d-rds-cluster-multi-az-availability-zones
Mar 16, 2026
Merged

docs: clarify availability_zones requirement for Multi-AZ DB clusters in aws_rds_cluster#46940
ewbankkit merged 2 commits intohashicorp:mainfrom
22skyy:d-rds-cluster-multi-az-availability-zones

Conversation

@22skyy
Copy link
Contributor

@22skyy 22skyy commented Mar 15, 2026

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.

Description

The availability_zones argument description in aws_rds_cluster does not distinguish between Aurora DB clusters and Multi-AZ DB clusters. Multi-AZ DB
clusters require exactly 3 Availability Zones in the DB subnet group, while Aurora DB clusters can operate with fewer AZs. This
PR adds a note to clarify this distinction.

Relations

Closes #37252

References

Output from Acceptance Testing

Not applicable. Only documentation is updated.

@22skyy
docs/rds_cluster: clarify availability_zones requirement for Multi-AZ…
53efcac 
… DB clusters

Multi-AZ DB clusters require exactly 3 Availability Zones in the DB
subnet group, while Aurora DB clusters can operate with fewer AZs.
This distinction was not documented, causing user confusion (hashicorp#37252).
@22skyy 22skyy requested a review from a team as a code owner March 15, 2026 07:56
@github-actions
Copy link
Contributor

github-actions bot commented Mar 15, 2026

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/rds Issues and PRs that pertain to the rds service. size/XS Managed by automation to categorize the size of a PR. labels Mar 15, 2026
@22skyy 22skyy changed the title docs/rds_cluster: clarify availability_zones requirement for Multi-AZ DB clusters docs: clarify availability_zones requirement for Multi-AZ DB clusters in aws_rds_cluster Mar 15, 2026
ewbankkit
ewbankkit previously approved these changes Mar 16, 2026
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 Mar 16, 2026
@ewbankkit ewbankkit self-assigned this Mar 16, 2026
@github-actions github-actions bot added the prioritized Part of the maintainer teams immediate focus. To be addressed within the current quarter. label Mar 16, 2026
@22skyy
docs/rds_cluster: fix tfproviderdocs check failure
14827f6 
Remove blank line and ~> admonition syntax from the Note to keep it
within the availability_zones list item, preventing the argument parser
from losing track of the arguments section.
@22skyy
Copy link
Contributor Author

22skyy commented Mar 16, 2026 •
edited
Loading

Fixed the tfproviderdocs check failure. The blank line and ~> admonition syntax was breaking the argument list parser, so I moved the note inline within the availability_zones list item.

14827f6

@22skyy 22skyy requested a review from ewbankkit March 16, 2026 13:14
ewbankkit
ewbankkit approved these changes Mar 16, 2026
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
Copy link
Contributor

ewbankkit commented Mar 16, 2026

@22skyy Thanks for the contribution 🎉 👏.

@ewbankkit ewbankkit merged commit 8d54c56 into hashicorp:main Mar 16, 2026
26 checks passed
@github-actions
Copy link
Contributor

github-actions bot commented Mar 16, 2026

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.37.0 milestone Mar 16, 2026
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

Assignees

@ewbankkit ewbankkit

Labels

documentation Introduces or discusses updates to documentation. prioritized Part of the maintainer teams immediate focus. To be addressed within the current quarter. service/rds Issues and PRs that pertain to the rds service. size/XS Managed by automation to categorize the size of a PR.

Projects

None yet

Milestone

v6.37.0

Development

Successfully merging this pull request may close these issues.

[Docs]: Documentation error in rds_cluster

2 participants

@22skyy @ewbankkit