Skip to content

Commit 505e234

Browse files
committed
update readme to add usage example
1 parent d2dfb04 commit 505e234

File tree

1 file changed

+26
-1
lines changed

1 file changed

+26
-1
lines changed

README.md

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,29 @@
1-
1+
# Terraform Module for S3 and DynamoDB for Terraform State Locking
2+
3+
This module creates an S3 bucket and a DynamoDB table, which can be used to store Terraform state files and lock state files to prevent concurrent modifications.
4+
5+
## Usage
6+
7+
To use this module, include it in your Terraform configuration like this:
8+
9+
```hcl
10+
module "tf_state_backend" {
11+
source = "github.com/infraspecdev/terraform-aws-s3-dynamodb-backend?ref=main"
12+
13+
s3_bucket_name = "unique-s3-bucket-name"
14+
dynamodb_table_name = "unique_dynamodb_table"
15+
dynamodb_read_capacity = 21
16+
dynamodb_write_capacity = 21
17+
dynamodb_table_tags = {
18+
Environment = "dev"
19+
Project = "backend"
20+
}
21+
s3_bucket_tags = {
22+
Environment = "dev"
23+
Project = "backend"
24+
}
25+
}
26+
```
227

328
## Requirements
429

0 commit comments

Comments
 (0)