Terraform管理AWSリソース名をリソースの再作成を避けてリネームする
目次
はじめに
こんにちは。shumpei です。
Terraformで管理しているAWSリソースのリソース名を後から変更したいと思ったことはあるでしょうか? リネームしたい場合、通常はただtfファイルを書き換えるだけだとリソースの削除と再作成が発生してしまいます。しかし、実際の環境では特に本番稼働中のリソースなど、再作成することは避けたいケースが多々あると思います。
そこで本記事では、リソースの再作成を避けながらTerraformのリソース名を変更する2つの方法を紹介していこうと思います。
前提条件
- Terraform 1.1以降(
movedブロック使用時) - AWS環境へのアクセス権限
- 既存のTerraformで管理されているリソース
方法1:terraform state mv コマンド
概要
terraform state mvコマンドは、Terraform stateファイル内のバインディングを変更し、既存のリモートオブジェクトを新しいリソースインスタンスに関連付けるコマンドです。
このコマンドは、リソース名を変更したり設定を再編成したりする際に、実際のインフラストラクチャをそのまま保持するために使用されます。コマンドライン(CLI)から直接実行するため、即座に反映されますが、実行履歴がコードとして残らないという特徴があります。
主な特徴:
- stateファイル内のリソースアドレスを直接操作
- コマンド実行時に自動的にバックアップが作成される
- Terraform 0.x系から利用可能な古くからある機能
- チーム環境では、実行前にメンバーへの周知が重要
手順
1. Terraform設定ファイルでリソース名を変更
# 変更前
resource "aws_instance" "old_name" {
ami = "ami-xxxxxxxxxxxxxxxxx"
instance_type = "t3.micro"
}
# 変更後
resource "aws_instance" "new_name" {
ami = "ami-xxxxxxxxxxxxxxxxx"
instance_type = "t3.micro"
}2. state mvコマンドを実行
terraform state mv aws_instance.old_name aws_instance.new_name実行すると以下のような出力が表示されます:
Move "aws_instance.old_name" to "aws_instance.new_name"
Successfully moved 1 object(s).3. planで変更がないことを確認
terraform plan
# No changes. Your infrastructure matches the configuration.方法2:moved ブロック(Terraform 1.1以降)
概要
movedブロックは、作成済みのリソースを破壊・再作成することなく、リソース名を変更できる機能です。この機能では、Terraformの設定ファイル内にfrom(移動元)とto(移動先)を明示的に記述します。
主な特徴:
.tfファイルに書くだけでよく、コマンド操作が不要terraform applyのタイミングで自動的にstateが書き換わるため、手動のstate操作ミスがない- PRレビューでリネームの意図を共有でき、チーム全員に変更が自動で適用される
- apply完了後は
movedブロックを削除してコードをクリーンに保てる
手順
1. リソース名を変更し、movedブロックを追加
resource "aws_instance" "new_name" {
ami = "ami-xxxxxxxxxxxxxxxxx"
instance_type = "t3.micro"
}
moved {
from = aws_instance.old_name
to = aws_instance.new_name
}2. planで確認
terraform plan出力例:
# aws_instance.old_name has moved to aws_instance.new_name
Plan: 0 to add, 0 to change, 0 to destroy.3. applyを実行
terraform apply※ apply後は追記したmovedブロックを削除しても問題ありません。
まとめ
Terraformでリソースをリネームする2つの方法を紹介しました。
- terraform state mv:即座に実行できて手軽に行えるため、個人開発や緊急対応などに向いている。ただしバージョン管理できない点に注意が必要です。
- moved ブロック:コードとしてリネームを管理できるため履歴として残せます。Terraform公式が推奨する方法で、チーム開発や本番環境での利用に適しています。
本記事が terraform での開発の一助となれば幸いです。
参考リンク
- Terraform公式ドキュメント – moved ブロック
- Terraform公式ドキュメント – state mvコマンド
