@@ -16,6 +16,20 @@ license: "APACHE2"
1616# Canonical GitHub repo
1717github_repo : cloudposse/terraform-aws-tfstate-backend
1818
19+ # Tags of this project
20+ tags :
21+ - aws
22+ - terraform
23+ - terraform-modules
24+ - terraform-state
25+ - terraform-state-backend
26+ - remote-state
27+ - s3
28+
29+ # Categories of this project
30+ categories :
31+ - terraform-modules/state
32+ - terraform-modules/state-backend
1933
2034# Badges to display
2135badges :
@@ -55,9 +69,9 @@ description: |-
5569
5670# How to use this project
5771usage : |-
58-
72+
5973 ### Create
60-
74+
6175 Follow this procedure just once to create your deployment.
6276
6377 1. Add the `terraform_state_backend` module to your `main.tf` file. The
@@ -94,7 +108,7 @@ usage: |-
94108 1. `terraform apply -auto-approve`. This creates the state bucket and DynamoDB locking
95109 table, along with anything else you have defined in your `*.tf` file(s). At
96110 this point, the Terraform state is still stored locally.
97-
111+
98112 Module `terraform_state_backend` also creates a new `backend.tf` file
99113 that defines the S3 state backend. For example:
100114 ```hcl
@@ -116,14 +130,14 @@ usage: |-
116130 Terraform state to the S3 backend, and it does so per `-auto-approve`. Now the
117131 state is stored in the S3 bucket, and the DynamoDB table will be used to lock
118132 the state to prevent concurrent modification.
119-
133+
120134 This concludes the one-time preparation. Now you can extend and modify your
121135 Terraform configuration as usual.
122136
123137 ### Destroy
124-
138+
125139 Follow this procedure to delete your deployment.
126-
140+
127141 1. In `main.tf`, change the `terraform_state_backend` module arguments as
128142 follows:
129143 ```hcl
@@ -143,13 +157,13 @@ usage: |-
143157 1. `terraform destroy`. This deletes all resources in your deployment.
144158 1. Examine local state file `terraform.tfstate` to verify that it contains
145159 no resources.
146-
160+
147161 <br/>
148162
149163 
150164
151165 ### Bucket Replication (Disaster Recovery)
152-
166+
153167 To enable S3 bucket replication in this module, set `s3_replication_enabled` to `true` and populate `s3_replica_bucket_arn` with the ARN of an existing bucket.
154168
155169 ```hcl
0 commit comments