ステート操作 (State Management)
tfstate ファイルの中身を確認したり、手動で修正したりするためのコマンド群です。
「インフラ自体は変更せず、Terraformの記憶(認識)だけを操作したい」時に使います。
1. terraform state list
現在、Terraformが管理している(Stateファイルに記録されている)リソースの一覧を表示します。
「今まで、何を作ったっけ?」や「importするためのリソース名を確認したい」という時に使います。
terraform state list
出力例
# aws_s3_bucket.my_bucket
# aws_instance.web
2. terraform state show
特定のリソースの詳細な設定値(IDやIPアドレスなど)を表示します。
下記のコマンドは、aws_instance.web の詳細を出力するコマンドです。
terraform state show aws_instance.web
3. terraform state mv
リソースの名前を変更したり、モジュールへ移動させたりする「リファクタリング」に使います。
コード上で名前を変えただけだと、Terraformは「古いリソースを削除して、新しいリソースを作成」しようとします(破壊的変更)。
state mv を使うことで、「削除・作成」を行わずに、Terraform上の名前だけを付け替えることができます。
下記は、aws_instance.old を aws_instance.new にリネームするコマンドです。
terraform state mv aws_instance.old aws_instance.new
4. terraform state rm
リソースを「Terraformの管理から外す」コマンドです。
terraform destroy はリソースを実際に削除しますが、state rm はリソース自体は残したまま、Terraformの記憶から消去します。
「importしたけど、やっぱりTerraform管理をやめたい」場合などに使います。
下記は、aws_s3_bucket.my_bucket このリソースを管理対象から外すコマンドです。リソース自体はAWS上には残ります。
terraform state rm aws_s3_bucket.my_bucket
| 📝 state rmとdestroyの違い |
|---|
terraform state rm はリソースを削除するコマンドではありません。Terraformの「管理対象から外す」だけで、AWS上のリソースはそのまま残り続けます。リソースを削除したい場合は terraform destroy を使用してください。逆に、リソースを残したままTerraform管理をやめたい場合に state rm を使います。 |