API Gateway v2 is missing support for updating route key

[davidaah]

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

Terraform Version

Terraform v0.12.26

Affected Resource(s)

• aws_apigatewayv2_route

Terraform Configuration Files

Initial configuration:

...
resource "aws_apigatewayv2_route" "test" {
  api_id    = aws_apigatewayv2_api.test.id
  route_key = "GET /mypath"

  target = "integrations/${aws_apigatewayv2_integration.test.id}"
}
...

Updated configuration:

...
resource "aws_apigatewayv2_route" "test" {
  api_id    = aws_apigatewayv2_api.test.id
  route_key = "GET /mynewpath"

  target = "integrations/${aws_apigatewayv2_integration.test.id}"
}
...

Expected Behavior

Route key should be updated

Confirm it is supported with AWS CLI:

$ aws apigatewayv2 update-route --api-id <api id> --route-id <route id> --route-key "GET /mynewpath"

{
    "RouteId": "<route id>",
    "RouteKey": "GET /mynewpath",
    "Target": "integrations/<integration id>"
}

In the debug output it appears that the updated "route key" is not sent in the API payload. Additionally, looking at the source referenced below, it looks like the Update directive is missing a condition for route_key

Actual Behavior

Error: error updating API Gateway v2 route: BadRequestException: Invalid route name content specified.

Steps to Reproduce

1. terraform apply with initial route key
2. terraform apply with the new route key

References

• https://github.com/terraform-providers/terraform-provider-aws/blob/master/aws/resource_aws_apigatewayv2_route.go#L162-L204

[ghost]

This has been released in version 3.0.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!