tencent cloud

All product documents
Tencent Infrastructure Automation for Terraform
DocumentationTencent Infrastructure Automation for TerraformUser GuideConfiguration GuideBackend
Backend
Download PDF
Last updated: 2024-12-02 16:01:33
Backend
Last updated: 2024-12-02 16:01:33
Download PDF

Remote state storage mechanism

Storing state files locally only may cause the following issues:
A tfstate file is stored locally in the current working directory by default. If computer damage causes file loss, all the resources corresponding to the tfstate file will become unmanageable, leading to a resource leak.
A tfstate file cannot be shared among team members.
To facilitate the storage and sharing of state files, Terraform introduces the remote state storage mechanism called "backend", an abstract remote storage API. Similar to a provider, backend supports a variety of remote storage services as described in Available Backends. A Terraform backend has two modes:
Standard: Supports remote state storage and state locking.
Enhanced: Supports remote operations (such as plan and apply on a remote server) in addition to the standard features.


Notes

After the backend configuration is updated, you need to run terraform init to verify and configure the backend.
If no custom backend is configured, Terraform will use the local backend by default. For example, a tfstate file is stored in the local directory by default.
Backend configuration is subject to the following restraints:
One configuration file provides only one backend block.
Backend blocks cannot reference named values (such as input variables, local variables, or data source attributes).

Using the backend

The definition of a backend block is nested in a top-level Terraform block. This document uses the Tencent Cloud Object Storage (COS) service as an example for configuration. For more information on other storage modes, see Available Backends.
terraform {
  backend "cos" {
    region = "ap-nanjing"
    bucket = "tfstate-cos-1308126961"
    prefix = "terraform/state"
  }
}
If you have the tfstate-cos-1308126961 bucket in COS, the Terraform state information will be written into the terraform/state/terraform.tfstate file as shown below:

Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

Contact Us

Contact our sales team or business advisors to help your business.

Contact Us
Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 available.

Submit a Ticket
7x24 Phone Support
Hong Kong, China
+852 800 906 020 (Toll Free)
United States
+1 844 606 0804 (Toll Free)
United Kingdom
+44 808 196 4551 (Toll Free)
Canada
+1 888 605 7930 (Toll Free)
Australia
+61 1300 986 386 (Toll Free)
EdgeOne hotline
+852 300 80699
More local hotlines coming soon