hashicorp / terraform-provider-aws

The AWS Provider enables Terraform to manage AWS resources.
https://registry.terraform.io/providers/hashicorp/aws
Mozilla Public License 2.0
9.74k stars 9.1k forks source link

[Docs]: YAML support for aws_cloudformation_stack Documentation Missing #29305

Open misilot opened 1 year ago

misilot commented 1 year ago

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] commented 1 year ago

Community Note

Voting for Prioritization

Volunteering to Work on This Issue

justinretzolk commented 1 year ago

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?