|
1 | 1 | # template of terraform resource repository |
2 | 2 |
|
3 | 3 | <!-- START_OF_AUTO_GENERATED_SECTION --> |
| 4 | +## Requirements |
| 5 | + |
| 6 | +| Name | Version | |
| 7 | +|------|---------| |
| 8 | +| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | ~>1.3.0 | |
| 9 | +| <a name="requirement_aws"></a> [aws](#requirement\_aws) | ~>4.20.0 | |
| 10 | + |
| 11 | +## Providers |
| 12 | + |
| 13 | +| Name | Version | |
| 14 | +|------|---------| |
| 15 | +| <a name="provider_aws"></a> [aws](#provider\_aws) | ~>4.20.0 | |
| 16 | +## Resources |
| 17 | + |
| 18 | +| Name | Type | |
| 19 | +|------|------| |
| 20 | +| [aws_dynamodb_table.terraform-state-lock](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/dynamodb_table) | resource | |
| 21 | +| [aws_kms_alias.state](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/kms_alias) | resource | |
| 22 | +| [aws_kms_key.state](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/kms_key) | resource | |
| 23 | +| [aws_s3_bucket.bucket](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/s3_bucket) | resource | |
| 24 | +| [aws_s3_bucket_public_access_block.bucket-acl](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/s3_bucket_public_access_block) | resource | |
| 25 | +## Inputs |
| 26 | + |
| 27 | +| Name | Description | Type | Default | Required | |
| 28 | +|------|-------------|------|---------|:--------:| |
| 29 | +| <a name="input_bucket_name"></a> [bucket\_name](#input\_bucket\_name) | S3 state bucket name | `string` | n/a | yes | |
| 30 | +| <a name="input_dynamodb_table_name"></a> [dynamodb\_table\_name](#input\_dynamodb\_table\_name) | DynamoDB state lock table name | `string` | n/a | yes | |
| 31 | +| <a name="input_tags"></a> [tags](#input\_tags) | n/a | `map(string)` | `{}` | no | |
| 32 | +| <a name="input_default_tags"></a> [default\_tags](#input\_default\_tags) | n/a | `map(string)` | <pre>{<br> "Module": "terraform-state"<br>}</pre> | no | |
| 33 | +## Outputs |
| 34 | + |
| 35 | +| Name | Description | |
| 36 | +|------|-------------| |
| 37 | +| <a name="output_state_bucket_name"></a> [state\_bucket\_name](#output\_state\_bucket\_name) | n/a | |
| 38 | +| <a name="output_state_table_name"></a> [state\_table\_name](#output\_state\_table\_name) | n/a | |
| 39 | +| <a name="output_state_table_arn"></a> [state\_table\_arn](#output\_state\_table\_arn) | n/a | |
| 40 | + |
| 41 | +## Examples |
| 42 | + |
| 43 | +### Basic example |
| 44 | +```hcl |
| 45 | +module "string_ssm_keys" { |
| 46 | + source = "[email protected]:masterborn/terraform-kms-tfstate-backend.git?ref=v1.0.0" |
| 47 | + bucket_name = "example-state-bucket" |
| 48 | + dynamodb_table_name = "example-state-lock" |
| 49 | +
|
| 50 | + tags = { |
| 51 | + Env = "Org" |
| 52 | + } |
| 53 | +} |
| 54 | +``` |
| 55 | + |
| 56 | +Then in backend configuration: |
| 57 | +```hcl |
| 58 | + backend "s3" { |
| 59 | + region = "us-east-1" |
| 60 | + bucket = "example-state-bucket" |
| 61 | + key = "path/to/file/terraform.tfstate" |
| 62 | + dynamodb_table = "example-state-lock" |
| 63 | + encrypt = true |
| 64 | + } |
| 65 | +``` |
4 | 66 | <!-- END_OF_AUTO_GENERATED_SECTION --> |
5 | 67 |
|
6 | 68 | ## Enabling pre-commit hooks |
|
0 commit comments