[Docs]: YAML support for aws_cloudformation_stack Documentation Missing

[misilot]

Documentation Link

https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/cloudformation_stack#template_url

Description

This PR https://github.com/hashicorp/terraform/pull/11121 seems to have added support for using YAML files with cloud formation templates, but no documentation was ever added on how to actually use this functionality.

References

https://github.com/hashicorp/terraform/pull/11121

Would you like to implement a fix?

No

[github-actions[bot]]

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.

[justinretzolk]

Hey @misilot 👋 Thank you for taking the time to raise this! I think the omission here was due to the ability to pass either JSON or YAML to the template_body in the same way (via HEREDOC, jsonencode() or yamlencode()). Since the process for supplying YAML isn't any different than supplying JSON, I'm not sure that there's a need to add a separate example. That said, perhaps we could make this more clear by indicating in the argument definition that either may be passed? Would that have made the documentation more clear to you when you were referencing it?

[github-actions[bot]]

Marking this issue as stale due to inactivity. This helps our maintainers find and focus on the active issues. If this issue receives no comments in the next 30 days it will automatically be closed. Maintainers can also remove the stale label.

If this issue was automatically closed and you feel this issue should be reopened, we encourage creating a new issue linking back to this one for added context. Thank you!

[misilot]

Hmm, sorry for the delay. I guess I didn't know you could change between yamlencode() or jsonencode() as all the examples I have seen only talk about JSON. So yes, I do believe something like an argument definition would have helped!