Better documentation for the id attribute for resources with a single primaryIdentifier property

[ewbankkit]

Community Note

• Please vote on this issue by adding a 👍 reaction to the original issue to help the community and maintainers prioritize this request
• 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
• If you are interested in working on this issue or have submitted a pull request, please leave a comment
• The resources and data sources in this provider are generated from the CloudFormation schema, so they can only support the actions that the underlying schema supports. For this reason submitted bugs should be limited to defects in the generation and runtime code of the provider. Customizing behavior of the resource, or noting a gap in behavior are not valid bugs and should be submitted as enhancements to AWS via the CloudFormation Open Coverage Roadmap.

Description

Every resource has an id attribute which uniquely identifies the resource.
Usually this attribute is synthesized and populated at runtime with the resource's primary identifier returned from the Cloud Control API. When the attribute is synthesized it is give the generic description Uniquely identifies the resource. which is then propagated to generated documentation for the resource.
If the resource has a single primaryIdentifier property specified in its CloudFormation resource schema then that property's description, which is likely to be more informative, can be used instead.