How to Import an AWS API Gateway Integration into Terraform

Import AWS API Gateway Integration with Terraback (recommended)

Terraback reverse-engineers your live infrastructure: it reads the Amazon API Gateway resource with read-only credentials, generates the HCL, and produces the exact import block. Two commands take you from a live AWS API Gateway Integration to managed Terraform.

terraback scan all aws --region us-east-1

terraback aws import --method bulk

The Terraform import block

Terraback emits a Terraform 1.5+ import block like the one below. Because the block lives in your configuration, the import is reviewable in a pull request and repeatable across environments.

import {
  to = aws_api_gateway_integration.example
  id = "12345abcde/67890fghij/GET"
}

Example aws_api_gateway_integration configuration

Here is a realistic AWS API Gateway Integration block. Terraback generates a fuller version from your actual resource attributes; this is a minimal, valid starting point.

resource "aws_api_gateway_integration" "example" {
  rest_api_id             = "12345abcde"
  resource_id             = "67890fghij"
  http_method             = "GET"
  type                    = "AWS_PROXY"
  integration_http_method = "POST"
  uri                     = "arn:aws:apigateway:us-east-1:lambda:path/2015-03-31/functions/arn:aws:lambda:us-east-1:123456789012:function:example/invocations"
}

Gotchas when importing a AWS API Gateway Integration

• An integration is a child of an aws_api_gateway_method on a specific resource; the parent method, resource, and REST API must exist first, and all three IDs make up the composite import ID.
• integration_http_method is required for AWS, AWS_PROXY, HTTP, and HTTP_PROXY types (it is almost always POST for Lambda) but must be omitted for MOCK; a mismatch causes a plan error after import.
• request_templates and request_parameters are read back verbatim and are whitespace sensitive, so expect cosmetic diffs until the HCL matches the deployed mapping exactly.
• The matching aws_api_gateway_integration_response is a separate resource with its own import ID; importing the integration alone does not bring in the response mapping.

Doing it manually with terraform import

The native approach is to write the aws_api_gateway_integration block by hand, then run terraform import aws_api_gateway_integration.example <import-id> for every resource, one at a time. That works for a handful of resources, but it does not scale: you author all the HCL yourself and repeat the command for each item. Terraback generates the HCL and the import blocks for your whole account in one pass.

Import other AWS resources