importブロックによる既存リソースの取り込み

コマンドラインで単発実行するのではなく、main.tf などのファイル内に「このリソースを取り込みたい」という宣言(import ブロック)を記述する方式です。

1. import ブロックとは

コマンドラインで単発実行するのではなく、main.tf などのファイル内に「このリソースを取り込みたい」という宣言(import ブロック)を記述する方式です。

これにより、以下のメリットがあります。

  • オプションを使うことで、リソース定義(HCL)を自動生成できる。
  • 「何をインポートしようとしているか」がコードとして履歴に残るため、レビューしやすい。

2. 記載方法

main.tf に以下のように記述します。

import {
  # to: Terraform上で何という名前にするか(これから作るリソース名)
  to = aws_s3_bucket.this

  # id: AWS上のリソースID(バケット名など)
  id = "manual-test-bucket-12345"
}

3. コード生成コマンド

import ブロックを書いた状態で、以下のオプションを付けて plan を実行すると、コードが生成されます。

terraform plan -generate-config-out=generated.tf
  • -generate-config-out=ファイル名: 指定したファイル名で、リソース定義のコードを出力します。

4. importブロックの動作確認

これが現在、既存リソースを取り込む最も推奨される簡単な方法です。その威力を体験してみましょう。

4.1 手動でのリソース作成

import ブロックのテストに使う既存リソースとして、今回は手動でS3バケットを作成します。

S3のダッシュボードを開き、左側のメニューから汎用バケットを選択し、中央にあるバケットの作成をクリックします。

バケット名は、my-import-test などのバケット名を入力します。S3のバケット名は全世界で一意になる必要があるため、日付など任意の文字を追加してください。

その他の項目はデフォルトで構いませんので、バケットの作成をクリックします。

4.2 importブロックの記述

main.tf に、以下の import ブロックだけ を記述します。

provider "aws" {
  region = "ap-northeast-1"
}

import {
  # Terraform上での名前を定義
  to = aws_s3_bucket.my_imported_bucket

  # 手動で作ったバケット名を指定
  id = "my-import-test-20260101"
}

4.3 コード生成の実行

ターミナルで以下のコマンドを実行します。

これにより、「importブロックの指示に従ってAWSを見に行き、その設定内容を generated.tf というファイルに書き出す」という処理が行われます。

terraform plan -generate-config-out=generated.tf
⚠️ 「Cannot write configuration」エラーが出る場合
generated.tfファイルがすでに存在しています。
既存のファイルを削除するか、別のファイル名(例:generated2.tf)を指定してください。
⚠️ 「NoSuchBucket」エラーが出る場合
指定したS3バケットが存在しません。
AWSコンソールでバケット名を確認し、importブロックのidの値を正しいバケット名に修正してください。

4.4 生成されたコードの確認

コマンドが成功すると、カレントディレクトリに新しく generated.tf というファイルができているはずです。中身を見てみましょう。

# __generated__ by Terraform
# Please review these resources and move them into your main configuration files.

# __generated__ by Terraform from "my-import-test-20260101"
resource "aws_s3_bucket" "my_imported_bucket" {
  bucket              = "my-import-test-20260101"
  bucket_prefix       = null
  force_destroy       = false
  object_lock_enabled = false
  region              = "ap-northeast-1"
  tags                = {}
  tags_all            = {}
}

このように、AWS上の設定値がすべて反映されたコードが自動生成されました!

手書きで苦労していた作業が一瞬で終わります。

5. 適用 (Apply)

現在は「コードを作った」段階で、Stateファイル(Terraformの記憶)への取り込みは完了していません。

apply を実行して、取り込みを確定させます。

terraform apply

これで、既存リソースの取り込みとコード化が完了しました。

6. リソースの削除

最後に、取り込んだリソースを削除しておきます。

terraform destroy

なお、terraform apply が成功して Stateファイルへの取り込みが完了したら、main.tf に書いた import ブロックは削除して構いません。(残しておいても害はありませんが、役割は終わったため消すのが一般的です)