How to Import an AWS API Gateway Integration Response into Terraform

Import AWS API Gateway Integration Response 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 Response 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_response.example
  id = "12345abcde/67890fghij/GET/200"
}

Example aws_api_gateway_integration_response configuration

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

resource "aws_api_gateway_integration_response" "example" {
  rest_api_id = "12345abcde"
  resource_id = "67890fghij"
  http_method = "GET"
  status_code = "200"

  response_templates = {
    "application/json" = ""
  }
}

Gotchas when importing a AWS API Gateway Integration Response

• This resource is one level deeper than the integration: the four-part import ID adds the status code, and the parent aws_api_gateway_integration plus its method and REST API must already exist.
• An integration response with a non-MOCK integration usually needs a matching aws_api_gateway_method_response for the same status code, or Terraform apply fails after import.
• response_templates and response_parameters are read back as-is and are sensitive to quoting and whitespace, so plan on cosmetic diffs until the HCL matches byte for byte.
• Terraback emits a depends_on tying the response to its integration; preserve that ordering so Terraform creates the integration before its response.

Doing it manually with terraform import

The native approach is to write the aws_api_gateway_integration_response block by hand, then run terraform import aws_api_gateway_integration_response.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