API Gateway v2 integration & route: ConflictException due to concurrent modification

[bklein1]

Terraform Core Version

1.5.5

AWS Provider Version

5.53.0

Affected Resource(s)

• aws_apigatewayv2_integration
• aws_apigatewayv2_route

Expected Behavior

Multiple routes should be added to a single integration without error.

Actual Behavior

When creating multiple routes a conflicting error pops up.

Relevant Error/Panic Output Snippet

Error: creating API Gateway v2 Route: operation error ApiGatewayV2: CreateRoute, https response error StatusCode: 409, ConflictException: Unable to complete operation due to concurrent modification. Please try again later.

Terraform Configuration Files

terraform {
  required_version = ">= 1.0.0, < 2.0.0"

  backend "local" {}

  required_providers {
    aws = {
      source  = "hashicorp/aws"
#       version = "= 5.44.0" // This version works!
      version = "= 5.53.0" // This version does not work
    }
    random = {
      source  = "hashicorp/random"
      version = ">= 3.6.0"
    }
    local = {
      source  = "hashicorp/local"
      version = ">= 2.0.0"
    }
  }
}

provider "aws" {
  region = "eu-central-1"
}


resource "aws_apigatewayv2_api" "api_gateway" {
  name             = "test-api-gw"
  protocol_type    = "HTTP"
  fail_on_warnings = true
}

resource "aws_apigatewayv2_integration" "api_gateway" {
  api_id             = aws_apigatewayv2_api.api_gateway.id
  integration_type   = "HTTP_PROXY"
  integration_method = "ANY"
  integration_uri    = "https://google.com"
}

resource "aws_apigatewayv2_route" "api_gateway_1" {
  api_id    = aws_apigatewayv2_api.api_gateway.id
  route_key = "ANY /key1"
  target    = "integrations/${aws_apigatewayv2_integration.api_gateway.id}"
}

resource "aws_apigatewayv2_route" "api_gateway_2" {
  api_id    = aws_apigatewayv2_api.api_gateway.id
  route_key = "ANY /key2"
  target    = "integrations/${aws_apigatewayv2_integration.api_gateway.id}"
}

resource "aws_apigatewayv2_route" "api_gateway_3" {
  api_id    = aws_apigatewayv2_api.api_gateway.id
  route_key = "ANY /key3"
  target    = "integrations/${aws_apigatewayv2_integration.api_gateway.id}"
}

resource "aws_apigatewayv2_route" "api_gateway_4" {
  api_id    = aws_apigatewayv2_api.api_gateway.id
  route_key = "ANY /key4"
  target    = "integrations/${aws_apigatewayv2_integration.api_gateway.id}"
}

resource "aws_apigatewayv2_route" "api_gateway_5" {
  api_id    = aws_apigatewayv2_api.api_gateway.id
  route_key = "ANY /key5"
  target    = "integrations/${aws_apigatewayv2_integration.api_gateway.id}"
}

Steps to Reproduce

• Initialize with aws provider version 5.53.0
• Apply changes
• Error will occur
• Destroy changes
• Set version to 5.44.0
• Apply changes --> This should work

Debug Output

No response

Panic Output

No response

Important Factoids

No response

References

This issue was already fixed once (see #18018). I searched through the files and found that this fix was deleted with this Pull Request: #36490

The file that contained the fix changed during time. But the latest file containing it was on path: internal/service/apigatewayv2/service_package.go

Would you like to implement a fix?

No

[github-actions]

Community Note

Voting for Prioritization

• Please vote on this issue by adding a 👍 reaction to the original post to help the community and maintainers prioritize this request.
• Please see our prioritization guide for information on how we prioritize.
• 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.

Volunteering to Work on This Issue

• If you are interested in working on this issue, please leave a comment.
• If this would be your first contribution, please review the contribution guide.

[ewbankkit]

Pre AWS SDK for Go v2 migration (v5.44.0):

terraform-provider-aws/internal/service/apigatewayv2/service_package.go

Lines 15 to 27 in b5ba61c

	// CustomizeConn customizes a new AWS SDK for Go v1 client for this service package's AWS API.
	func (p *servicePackage) CustomizeConn(ctx context.Context, conn *apigatewayv2_sdkv1.ApiGatewayV2) (*apigatewayv2_sdkv1.ApiGatewayV2, error) {
	conn.Handlers.Retry.PushBack(func(r *request_sdkv1.Request) {
	// Many operations can return an error such as:
	// ConflictException: Unable to complete operation due to concurrent modification. Please try again later.
	// Handle them all globally for the service client.
	if tfawserr.ErrMessageContains(r.Error, apigatewayv2_sdkv1.ErrCodeConflictException, "try again later") {
	r.Retryable = aws_sdkv1.Bool(true)
	}
	})
	return conn, nil
	}

[ewbankkit]

Relates #37732.

[github-actions]

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]

This functionality has been released in v5.54.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. Thank you!

[github-actions]

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.