internal/keyvaluetags: New Go package for consistently managing resource tags

[bflad]

Community Note

• Please vote on this pull request by adding a 👍 reaction to the original pull request comment to help the community and maintainers prioritize this request
• Please do not leave "+1" comments, they generate extra noise for pull request followers and do not help prioritize the request

Release note for CHANGELOG:

NONE

The keyvaluetags package is designed to provide a consistent interface for handling AWS resource key-value tags. Many of the AWS Go SDK services, implement their own Go struct with Key and Value fields (e.g. athena.Tag) while others simply use a map (e.g. map[string]string). These inconsistent implementations and numerous Go types makes the process of correctly working with each of the services a tedius, previously copy-paste-modify process.

This package instead implements a single KeyValueTags type, which covers all key-value handling logic such as merging tags and ignoring keys via functions on the single type. Much of the code associated with tagging operations can be code generated. Adding tagging abilities for new AWS services now only requires a few lines of code.

Output from acceptance testing:

--- PASS: TestAccAWSAthenaWorkGroup_disappears (13.62s)
--- PASS: TestAccAWSAthenaWorkGroup_Configuration_ResultConfiguration_EncryptionConfiguration_SseS3 (20.73s)
--- PASS: TestAccAWSAthenaWorkGroup_Configuration_BytesScannedCutoffPerQuery (25.21s)
--- PASS: TestAccAWSAthenaWorkGroup_Description (29.82s)
--- PASS: TestAccAWSAthenaWorkGroup_Configuration_EnforceWorkgroupConfiguration (31.01s)
--- PASS: TestAccAWSAthenaWorkGroup_Configuration_PublishCloudWatchMetricsEnabled (36.91s)
--- PASS: TestAccAWSAthenaWorkGroup_Tags (40.80s)
--- PASS: TestAccAWSAthenaWorkGroup_State (43.45s)
--- PASS: TestAccAWSAthenaWorkGroup_basic (57.10s)
--- PASS: TestAccAWSAthenaWorkGroup_Configuration_ResultConfiguration_EncryptionConfiguration_Kms (59.79s)
--- PASS: TestAccAWSAthenaWorkGroup_Configuration_ResultConfiguration_OutputLocation (60.00s)

[ewbankkit]

SO happy for this 😃 😃 😃.
Will there be support for services (S3 springs to mind) where there are no operation to explictly update tags, just operations to put and delete the full set of tags on a resource?

[bflad]

Will there be support for services (S3 springs to mind) where there are no operation to explictly update tags, just operations to put and delete the full set of tags on a resource?

I think once we get through a first pass of covering most of the "regular" services, we can look to migrate the very customized services into this new package as well. If nothing else, to at least use the same underlying functionality of the package, even if the wrapping code is not automatically generated. 😄

[bflad]

Rebased against master to resolve merge conflict with GNUmakefile

[tombuildsstuff]

LGTM 👍

[bflad]

My immediate plan after merging:

• Implement EKS tagging and document the process in the Contributing Guide
• Fix the CloudHSMv2 multiple tags issue
• Switchover aws_vpc and aws_subnet resources to prepare for a planned proof of concept

[ghost]

This has been released in version 2.31.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 for triage. Thanks!

[ghost]

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 feel this issue should be reopened, we encourage creating a new issue linking back to this one for added context. Thanks!