Google CloudCloud Schedulergoogle_cloud_scheduler_jobPro

How to Import an Google Cloud Scheduler Job into Terraform

To import an existing Google Cloud Scheduler Job into Terraform, scan it with Terraback and run terraback gcp import --method bulk. Terraback writes the matching google_cloud_scheduler_job resource block and the Terraform 1.5+ import block for you, so you do not have to run terraform import by hand. The import ID is the full path projects/{project}/locations/{location}/jobs/{name} (for example, projects/my-project/locations/us-central1/jobs/daily-report).

Import Google Cloud Scheduler Job with Terraback (recommended)

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

1

Scan your Google Cloud account

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

Generate import blocks and import into state

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_cloud_scheduler_job.daily
  id = "projects/my-project/locations/us-central1/jobs/daily-report"
}

Example google_cloud_scheduler_job configuration

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

resource "google_cloud_scheduler_job" "daily" {
  name      = "daily-report"
  region    = "us-central1"
  schedule  = "0 9 * * *"
  time_zone = "America/New_York"

  http_target {
    uri         = "https://example.com/run"
    http_method = "POST"
  }
}

Gotchas when importing a Google Cloud Scheduler Job

  • In the import path the region appears as a locations/<region> segment, but in HCL the attribute is named region.
  • Exactly one target block (http_target, pubsub_target, or app_engine_http_target) is set; match whichever the job uses.
  • Request bodies are stored base64-encoded in the API, so a plaintext body in HCL can show a diff until it is base64-encoded.
  • oauth_token and oidc_token service-account details are required for authenticated targets and may need to be re-supplied after import.

Doing it manually with terraform import

The native approach is to write the google_cloud_scheduler_job block by hand, then run terraform import google_cloud_scheduler_job.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 your whole Google Cloud account in minutes

Terraback scans 80+ Google Cloud resource types and emits clean Terraform plus import blocks, running locally with read-only credentials. $499 once, no SaaS.