Skip to content
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

[Docs]: aws_rds_cluster: Incorrect description for enable_http_endpoint Argument #35370

Closed
timdeluxe opened this issue Jan 18, 2024 · 5 comments · Fixed by #37287
Closed

[Docs]: aws_rds_cluster: Incorrect description for enable_http_endpoint Argument #35370

timdeluxe opened this issue Jan 18, 2024 · 5 comments · Fixed by #37287
Labels
documentation Introduces or discusses updates to documentation. good first issue Call to action for new contributors looking for a place to start. Smaller or straightforward issues. service/rds Issues and PRs that pertain to the rds service.
Milestone

Comments

@timdeluxe
Copy link

Documentation Link

https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/rds_cluster#enable_http_endpoint

Description

The description of that argument says that it is only valid, when engine_mode is set to "serverless", but this is not true anymore. Serverless v2 now also supports Data API for postgresql DBs and neither this module nor the AWS API stops one from doing so, which means code with enable_http_endpoint on engine_mode "provisioned" (= Serverless v2) does work. It is just the documentation which is wrong.

It should say: (Optional) Enable HTTP endpoint (data API). Only valid when engine_mode is set to serverless or (if engine is set to aurora-postgresql) to provisioned.

References

https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.Aurora_Fea_Regions_DB-eng.Feature.Data_API.html

Would you like to implement a fix?

No

@timdeluxe timdeluxe added the documentation Introduces or discusses updates to documentation. label Jan 18, 2024
Copy link

Community Note

Voting for Prioritization

  • Please vote on this issue by adding a 👍 reaction to the original post to help the community and maintainers prioritize this request.
  • Please see our prioritization guide for information on how we prioritize.
  • Please do not leave "+1" or other comments that do not add relevant new information or questions, they generate extra noise for issue followers and do not help prioritize the request.

Volunteering to Work on This Issue

  • If you are interested in working on this issue, please leave a comment.
  • If this would be your first contribution, please review the contribution guide.

@terraform-aws-provider terraform-aws-provider bot added the needs-triage Waiting for first response or review from a maintainer. label Jan 18, 2024
@justinretzolk justinretzolk added good first issue Call to action for new contributors looking for a place to start. Smaller or straightforward issues. service/rds Issues and PRs that pertain to the rds service. and removed needs-triage Waiting for first response or review from a maintainer. labels Jan 18, 2024
@jackedgar24
Copy link

I will make this change and open a PR,

Copy link

github-actions bot commented May 6, 2024

Warning

This issue has been closed, meaning that any additional comments are hard for our team to see. 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 v5.49.0 milestone May 6, 2024
Copy link

This functionality has been released in v5.49.0 of the Terraform AWS Provider. Please see the Terraform documentation on provider versioning or reach out if you need any assistance upgrading.

For further feature requests or bug reports with this functionality, please create a new GitHub issue following the template. Thank you!

Copy link

github-actions bot commented Jun 9, 2024

I'm going to lock this issue because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues.
If you have found a problem that seems similar to this, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jun 9, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Introduces or discusses updates to documentation. good first issue Call to action for new contributors looking for a place to start. Smaller or straightforward issues. service/rds Issues and PRs that pertain to the rds service.
Projects
None yet
3 participants