How to Import an Google API Gateway Gateway into Terraform

Import Google API Gateway Gateway with Terraback (recommended)

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

terraback scan all gcp --project my-gcp-project

terraback gcp 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 = google_api_gateway_gateway.prod
  id = "projects/my-project/locations/us-central1/gateways/prod-gw"
}

Example google_api_gateway_gateway configuration

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

resource "google_api_gateway_gateway" "prod" {
  provider   = google-beta
  gateway_id = "prod-gw"
  api_config = google_api_gateway_api_config.prod.id
  region     = "us-central1"

  display_name = "Production Gateway"
}

Gotchas when importing a Google API Gateway Gateway

• API Gateway is a beta resource, so the gateway, its api, and api_config all need provider = google-beta.
• A gateway points at a single immutable api_config; rolling out a new config means creating a new api_config and updating the reference, which is why create_before_destroy is common on the config.
• The region in the import path is the gateway location (for example us-central1); the parent google_api_gateway_api lives in the global location.
• Deleting a gateway does not delete the underlying managed service or the api_config it referenced; clean those up separately.

Doing it manually with terraform import

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