[Docs]: aws_guardduty_malware_protection_plan role argument reference should specify that it requires a role ARN

[kxgillispie]

Documentation Link

https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/guardduty_malware_protection_plan#role

Description

Documentation for resource aws_guardduty_malware_protection_plan's argument role says only:

The IAM role that includes the permissions required to scan and add tags to the associated protected resource.

Based on both the code example from the same link (which specifies role = aws_iam_role.example.arn), and errors we've received when attempting to use a role name instead (detailed below), it seems that this argument specifically requires an ARN; it would be helpful if the documentation was updated accordingly.

===

Additionally, it seems that the URL fragment for that role attribute doesn't function as expected; when clicking on the attribute name the fragment is added to the URL displayed in the browser, but attempting to navigate to that URL directly does not result in the view being scrolled to it (as it does with other fragment URLs from that same page, like for the tags attribute: https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/guardduty_malware_protection_plan#tags).

===

Error from attempting to use role name for this argument instead of ARN:

Planning failed. Terraform encountered an error while generating this plan.

╷
│ Error: Provider produced invalid plan
│ 
│ Provider "registry.terraform.io/hashicorp/aws" planned an invalid value for
│ aws_guardduty_malware_protection_plan.protection_plan.role: planned value
│ cty.UnknownVal(cty.String) does not match config value
│ cty.StringVal("GuardDutyMalwareProtectionRole").
│ 
│ This is a bug in the provider, which should be reported in the provider's
│ own issue tracker.
╵
Operation failed: failed running terraform plan (exit 1)

References

No response

Would you like to implement a fix?

None

[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.

[stefanfreitag]

Hi @kxgillispie,

let me look into this.

• The ARN details should be easy to add.

• On the URL fragment issue you reported I noticed a missing "name" in the a href.

  

  Out of curiosity I searched for similar documentation snippets for other resources and noticed the same issue for Lambda functions (here). If possible, I would like to keep fixing this separate from improving the resource description.

[github-actions[bot]]

[!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[bot]]

This functionality has been released in v5.62.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!

[github-actions[bot]]

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.