Data source aws_api_gateway_api_key lookup on name (not id)

[runesl]

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 "me too" comments, 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

Description

It should be possible to lookup aws_api_gateway_api_key by name.
For example:

data "aws_api_gateway_api_key" "my-api-key" {
  name = "my_api_key_name"
}

Currently only id is supported, so this happens:

Error: data.aws_api_gateway_api_key.api-key: "id": required field is not set

[RomanGlova]

Looks like cannot be implemented since you can have same name on different keys

[runesl]

A lot of Terraform data sources work like I propose. They fail only when multiple instances matching the criteria are actually found. Looking up EBS volumes by tag for instance.

[JulienBlancher]

+1 for this! looking up by id is not very useful.

[mikiisz]

+1, are there any new updates about that feature request?

[jhourque]

+1, this is a nice feature but I think it would need to create a new data source : aws_api_gateway_api_keys
aws_api_gateway_api_key is based on AWS API get-api-key which only allow api key id as parameter.
aws_api_gateway_api_keys could be based on get-api-keys API which could request on name.

Anyway this is a must have feature.

[d8aninja]

Many AWS resources can have identical names and differing IDs/ARNs; why is this one special? This is a must have feature, still, going into 2024...