Terraform 管理の API Gateway Lambda 統合で 429 THROTTLED と出るとき

事象

terraform plan / apply で API Gateway Lambda 統合を作ってた時、なんか動作確認で応答してくれない・エラーになった。原因をマネコンで探していると、下記のようにスロットリングの設定が 0 になっていた。

原因と対処

• 公式 module のデフォルト設定で throttling_rate_limit などが 0 になってしまう (https://github.com/hashicorp/terraform-provider-aws/issues/30373)
• throttling_rate_limit > throttling_burst_limit だったからかも

ということで明示しましょう：

resource "aws_apigatewayv2_stage" "default" {
  name        = "default"
  description = "Created by AWS Lambda"
  api_id      = aws_apigatewayv2_api.api.id
  auto_deploy = true

  access_log_settings {
    destination_arn = aws_cloudwatch_log_group.apigateway_log_group.arn
    format          = replace(file("${path.module}/api_gateway_log_format.json"), "\r\n", "")
  }

  default_route_settings {
    logging_level            = "ERROR"
    detailed_metrics_enabled = true
+   throttling_rate_limit    = 1
+   throttling_burst_limit   = 2
  }
}

おまけ：api_gateway_log_format.json は次のような json です。

api_gateway_log_format.json

{
  "requestId": "$context.requestId",
  "ip": "$context.identity.sourceIp",
  "caller": "$context.identity.caller",
  "user": "$context.identity.user",
  "requestTime": "$context.requestTime",
  "responseLatency": "$context.responseLatency",
  "protocol": "$context.protocol",
  "httpMethod": "$context.httpMethod",
  "resourcePath": "$context.resourcePath",
  "status": "$context.status",
  "error_message": "$context.error.message",
  "error_response_type": "$context.error.responseType",
  "integrationError": "$context.integration.error",
  "integrationErrorMessage": "$context.integrationErrorMessage",
  "integrationStatus": "$context.integration.integrationStatus",
  "integrationLatency": "$context.integration.latency"
}