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.8k stars 9.15k forks source link

[Enhancement]: rename aws_cloudfrontkeyvaluestore_key #36684

Closed camilbinas closed 6 months ago

camilbinas commented 6 months ago

Description

The aws_cloudfrontkeyvaluestore_key resource currently doesn't align with the naming convention of other Cloudfront resources. It should be named "aws_cloudfront_key_value_store_key". Also the resource is located in a separate navigation group in the documentation: "CloudFront KeyValueStore" instead of "CloudFront" which makes it harder to find the example.

Affected Resource(s) and/or Data Source(s)

aws_cloudfrontkeyvaluestore_key

Potential Terraform Configuration

resource "aws_cloudfront_key_value_store" "example" {
  name    = "ExampleKeyValueStore"
  comment = "This is an example key value store"
}

resource "aws_cloudfront_key_value_store_key" "example" {
  key_value_store_arn = aws_cloudfront_key_value_store.example.arn
  key                 = "Test Key"
  value               = "Test Value"
}

References

No response

Would you like to implement a fix?

None

github-actions[bot] commented 6 months ago

Community Note

Voting for Prioritization

Volunteering to Work on This Issue

justinretzolk commented 6 months ago

Hey @camilbinas 👋 Thank you for taking the time to raise this! While we acknowledge that one might initially expect this resource to be named aws_cloudfront_key_value_store_key, naming it aws_cloudfrontkeyvaluestore_key more closely matches the SDK and underlying API:

Following the API/SDK as closely as possible is one of the provider design principles, and something we try to do where possible (for another example, see aws_servicecatalogappregistry_application). With that in mind, I'm going to close this issue.

github-actions[bot] commented 6 months ago

[!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] commented 5 months ago

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.