importコマンドによる既存リソースの取り込み
すでに手動で作成してある AWS リソースを、あとから Terraform の管理下に置きたい場面があります。コードに resource ブロックを書いただけでは Terraform は別の新しいリソースを作ろうとしてしまうため、既存リソースの実体と対応付ける作業が必要です。terraform import コマンドを使うと、既存リソースの ID を tfstate に書き込んで対応付けができます。ここでは .tf ファイル側は自分で書く必要がある前提を含めて、基本手順を順に見ていきます。
1. 概要
1.1 import とは
通常、Terraformでコードを書くと、「新しくリソースを作成」しようとします。もし、手動(マネジメントコンソール)で作成したリソースがある状態で、コードにリソースを定義して terraform apply をすると、Terraformはそれを「全く新しいリソース」として作成しようとします。その結果、リソース名の重複禁止制約(S3バケット名など)に引っかかりエラーになるか、あるいは意図せず二重にリソースが作成されてしまいます。
そのため、Terraformに 「このコード上のリソース定義は、AWS上にあるあのリソース(ID: xxx)のことです」 と紐付けを行う必要があります。そのために、Stateファイルに情報を記録させる作業が import です。
2. 前提
terraform import コマンドには、以下の特徴があります。
- AWS上のリソース情報をTerraformの記憶(tfstate)に書き込むだけで、Stateファイルを作る処理に閉じています。
.tfファイルへの記述は自動生成されず、自分で行う必要があります。
つまり、「先にリソース定義(resourceブロック)を書く」→「コマンドで紐付ける」→「設定値をコードに書き写して埋める」という手順が必要になります。
この後説明する import ブロックを使うと、Terraformのコード生成も自動で行うことができます。ひとまずは、従来の方法である import コマンドを使ってみます。
3. コマンドの構文
terraform import [オプション] アドレス ID
アドレスにはコード上のリソース名を指定します(例:aws_s3_bucket.my_bucket)IDにはAWS上のリソースIDを指定します(例: バケット名やインスタンスID)
なお、IDとしてどの属性(値)を指定するかは、リソースのタイプによって異なります。
4. importコマンドの動作確認
今回は、先ほど作成した test-vpc をTerraformに取り込む手順を体験してみましょう。
4.1 コードの受け皿の準備 (main.tf)
Terraform側に、「これに取り込みたい」という定義場所(受け皿)を作ります。 main.tf に以下を記述してください。
provider "aws" {
region = "ap-northeast-1"
}
resource "aws_vpc" "import_vpc" {
cidr_block = "10.0.0.0/16"
tags = {
"Name" = "test-vpc"
}
}
4.2 importコマンドの実行
ターミナルで以下のコマンドを実行し、リソースを取り込みます。[VPC_ID] の部分は、先ほど作った test_vpc のIDに置き換えてください。
terraform import aws_vpc.import_vpc [VPC_ID]
| ⚠️ 「Cannot import non-existent」エラーが出る場合 |
|---|
| 指定したVPC IDが存在しません。 AWSコンソールでVPCの一覧を確認し、正しいIDを指定してください。 リージョンが異なる場合も同様のエラーが発生します。 |
| ⚠️ 「Resource already managed」エラーが出る場合 |
|---|
このリソースはすでにTerraformの管理下にあります。terraform state listコマンドで現在の状態を確認し、必要に応じてterraform state rmでStateから除外してから再度importしてください。 |
成功すると、Import successful! と表示されます。 これで、TerraformはこのVPCを「自分が管理しているもの」として認識しました。
4.3 整合性の確認 (terraform plan)
正しく取り込めたか、そしてコードと現状にズレがないか確認します。
terraform plan
もし No changes. と表示されたら、コードと実物が一致しています。
もし ~ update in-place(変更あり)と表示された場合、それは「手動で作った時の設定」と「現在のコード」の間に差があることを意味します。
この場合、Terraformは「コードに合わせて設定を戻そう(変更しよう)」としてしまいます。そのため、この plan の結果を見ながら、コード側に足りない設定(cidr_block や tags など)を追記して、No changes になるように修正作業を行います。
4.4 リソースの削除
Terraform管理下に入ったので、terraform destroy で削除することができます。
terraform destroy
これで、手動で作ったVPCもTerraform経由できれいに削除されました。