terraform/website/docs/cli/state/move.html.md

1.9 KiB

layout page_title description
docs Moving Resources - Terraform CLI Commands that allow you to manage the way that resources are tracked in state. They are helpful when you move or change resources.

Moving Resources

Terraform's state associates each real-world object with a configured resource at a specific resource address. This is seamless when changing a resource's attributes, but Terraform will lose track of a resource if you change its name, move it to a different module, or change its provider.

Usually that's fine: Terraform will destroy the old resource, replace it with a new one (using the new resource address), and update any resources that rely on its attributes.

In cases where it's important to preserve an existing infrastructure object, you can explicitly tell Terraform to associate it with a different configured resource.

  • The terraform state mv command changes which resource address in your configuration is associated with a particular real-world object. Use this to preserve an object when renaming a resource, or when moving a resource into or out of a child module.

    Hands On: Try the Use Configuration to Move Resources on HashiCorp Learn.

  • The terraform state rm command tells Terraform to stop managing a resource as part of the current working directory and workspace, without destroying the corresponding real-world object. (You can later use terraform import to start managing that resource in a different workspace or a different Terraform configuration.)

  • The terraform state replace-provider command transfers existing resources to a new provider without requiring them to be re-created.