{"id":14957859,"url":"https://github.com/cloudposse/terraform-aws-tfstate-backend","last_synced_at":"2025-05-15T10:06:35.835Z","repository":{"id":38805536,"uuid":"126348476","full_name":"cloudposse/terraform-aws-tfstate-backend","owner":"cloudposse","description":"Terraform module that provision an S3 bucket to store the `terraform.tfstate` file and a DynamoDB table to lock the state file to prevent concurrent modifications and state corruption.","archived":false,"fork":false,"pushed_at":"2025-03-13T00:31:05.000Z","size":3458,"stargazers_count":418,"open_issues_count":8,"forks_count":179,"subscribers_count":26,"default_branch":"main","last_synced_at":"2025-04-14T16:57:21.346Z","etag":null,"topics":["aws","aws-dynamodb","backend","dynamodb","dynamodb-table","hcl2","locking","remote-state","s3-bucket","terraform","terraform-module","terraform-modules","terraform-state","tfstate"],"latest_commit_sha":null,"homepage":"https://cloudposse.com/accelerate","language":"HCL","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cloudposse.png","metadata":{"funding":{"github":"cloudposse"},"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-03-22T14:34:03.000Z","updated_at":"2025-04-07T19:01:14.000Z","dependencies_parsed_at":"2024-02-14T04:23:52.050Z","dependency_job_id":"5fd8c842-4cc3-4126-afe8-c48f9922ac21","html_url":"https://github.com/cloudposse/terraform-aws-tfstate-backend","commit_stats":{"total_commits":95,"total_committers":42,"mean_commits":2.261904761904762,"dds":0.8947368421052632,"last_synced_commit":"2b838e369cc60cdca68ca2549ec3427aa31861cd"},"previous_names":[],"tags_count":67,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloudposse%2Fterraform-aws-tfstate-backend","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloudposse%2Fterraform-aws-tfstate-backend/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloudposse%2Fterraform-aws-tfstate-backend/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloudposse%2Fterraform-aws-tfstate-backend/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cloudposse","download_url":"https://codeload.github.com/cloudposse/terraform-aws-tfstate-backend/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254319719,"owners_count":22051073,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["aws","aws-dynamodb","backend","dynamodb","dynamodb-table","hcl2","locking","remote-state","s3-bucket","terraform","terraform-module","terraform-modules","terraform-state","tfstate"],"created_at":"2024-09-24T13:15:43.532Z","updated_at":"2025-05-15T10:06:30.819Z","avatar_url":"https://github.com/cloudposse.png","language":"HCL","funding_links":["https://github.com/sponsors/cloudposse"],"categories":[],"sub_categories":[],"readme":"\n\n\u003c!-- markdownlint-disable --\u003e\n\u003ca href=\"https://cpco.io/homepage\"\u003e\u003cimg src=\"https://github.com/cloudposse/terraform-aws-tfstate-backend/blob/main/.github/banner.png?raw=true\" alt=\"Project Banner\"/\u003e\u003c/a\u003e\u003cbr/\u003e\n    \u003cp align=\"right\"\u003e\n\u003ca href=\"https://github.com/cloudposse/terraform-aws-tfstate-backend/releases/latest\"\u003e\u003cimg src=\"https://img.shields.io/github/release/cloudposse/terraform-aws-tfstate-backend.svg?style=for-the-badge\" alt=\"Latest Release\"/\u003e\u003c/a\u003e\u003ca href=\"https://github.com/cloudposse/terraform-aws-tfstate-backend/commits\"\u003e\u003cimg src=\"https://img.shields.io/github/last-commit/cloudposse/terraform-aws-tfstate-backend.svg?style=for-the-badge\" alt=\"Last Updated\"/\u003e\u003c/a\u003e\u003ca href=\"https://slack.cloudposse.com\"\u003e\u003cimg src=\"https://slack.cloudposse.com/for-the-badge.svg\" alt=\"Slack Community\"/\u003e\u003c/a\u003e\u003c/p\u003e\n\u003c!-- markdownlint-restore --\u003e\n\n\u003c!--\n\n\n\n\n  ** DO NOT EDIT THIS FILE\n  **\n  ** This file was automatically generated by the `cloudposse/build-harness`.\n  ** 1) Make all changes to `README.yaml`\n  ** 2) Run `make init` (you only need to do this once)\n  ** 3) Run`make readme` to rebuild this file.\n  **\n  ** (We maintain HUNDREDS of open source projects. This is how we maintain our sanity.)\n  **\n\n\n\n\n\n--\u003e\n\nTerraform module to provision an S3 bucket to store `terraform.tfstate` file and a DynamoDB table to lock the state file\nto prevent concurrent modifications and state corruption.\n\nThe module supports the following:\n\n1. Forced server-side encryption at rest for the S3 bucket\n2. S3 bucket versioning to allow for Terraform state recovery in the case of accidental deletions and human errors\n3. State locking and consistency checking via DynamoDB table to prevent concurrent operations\n4. DynamoDB server-side encryption\n\nhttps://www.terraform.io/docs/backends/types/s3.html\n\n\n__NOTE:__ The operators of the module (IAM Users) must have permissions to create S3 buckets and DynamoDB tables when performing `terraform plan` and `terraform apply`\n\n__NOTE:__ This module cannot be used to apply changes to the `mfa_delete` feature of the bucket. Changes regarding mfa_delete can only be made manually using the root credentials with MFA of the AWS Account where the bucket resides. Please see: https://github.com/terraform-providers/terraform-provider-aws/issues/629\n\n\n\u003e [!TIP]\n\u003e #### 👽 Use Atmos with Terraform\n\u003e Cloud Posse uses [`atmos`](https://atmos.tools) to easily orchestrate multiple environments using Terraform. \u003cbr/\u003e\n\u003e Works with [Github Actions](https://atmos.tools/integrations/github-actions/), [Atlantis](https://atmos.tools/integrations/atlantis), or [Spacelift](https://atmos.tools/integrations/spacelift).\n\u003e\n\u003e \u003cdetails\u003e\n\u003e \u003csummary\u003e\u003cstrong\u003eWatch demo of using Atmos with Terraform\u003c/strong\u003e\u003c/summary\u003e\n\u003e \u003cimg src=\"https://github.com/cloudposse/atmos/blob/main/docs/demo.gif?raw=true\"/\u003e\u003cbr/\u003e\n\u003e \u003ci\u003eExample of running \u003ca href=\"https://atmos.tools\"\u003e\u003ccode\u003eatmos\u003c/code\u003e\u003c/a\u003e to manage infrastructure from our \u003ca href=\"https://atmos.tools/quick-start/\"\u003eQuick Start\u003c/a\u003e tutorial.\u003c/i\u003e\n\u003e \u003c/detalis\u003e\n\n\n\n\n\n## Usage\n\n\n### Create\n\nFollow this procedure just once to create your deployment.\n\n1. Add the `terraform_state_backend` module to your `main.tf` file. The\n   comment will help you remember to follow this procedure in the future:\n   ```hcl\n   # You cannot create a new backend by simply defining this and then\n   # immediately proceeding to \"terraform apply\". The S3 backend must\n   # be bootstrapped according to the simple yet essential procedure in\n   # https://github.com/cloudposse/terraform-aws-tfstate-backend#usage\n   module \"terraform_state_backend\" {\n     source = \"cloudposse/tfstate-backend/aws\"\n     # Cloud Posse recommends pinning every module to a specific version\n     # version     = \"x.x.x\"\n     namespace  = \"eg\"\n     stage      = \"test\"\n     name       = \"terraform\"\n     attributes = [\"state\"]\n\n     terraform_backend_config_file_path = \".\"\n     terraform_backend_config_file_name = \"backend.tf\"\n     force_destroy                      = false\n   }\n\n   # Your Terraform configuration\n   module \"another_module\" {\n     source = \".....\"\n   }\n   ```\n   Module inputs `terraform_backend_config_file_path` and\n   `terraform_backend_config_file_name` control the name of the backend\n   definition file. Note that when `terraform_backend_config_file_path` is\n   empty (the default), no file is created.\n\n1. `terraform init`. This downloads Terraform modules and providers.\n\n1. `terraform apply -auto-approve`. This creates the state bucket and DynamoDB locking\n   table, along with anything else you have defined in your `*.tf` file(s). At\n   this point, the Terraform state is still stored locally.\n\n   Module `terraform_state_backend` also creates a new `backend.tf` file\n   that defines the S3 state backend. For example:\n   ```hcl\n   backend \"s3\" {\n     region         = \"us-east-1\"\n     bucket         = \"\u003c the name of the S3 state bucket \u003e\"\n     key            = \"terraform.tfstate\"\n     dynamodb_table = \"\u003c the name of the DynamoDB locking table \u003e\"\n     profile        = \"\"\n     role_arn       = \"\"\n     encrypt        = true\n   }\n   ```\n\n   Henceforth, Terraform will also read this newly-created backend definition\n   file.\n\n1. `terraform init -force-copy`. Terraform detects that you want to move your\n   Terraform state to the S3 backend, and it does so per `-auto-approve`. Now the\n   state is stored in the S3 bucket, and the DynamoDB table will be used to lock\n   the state to prevent concurrent modification.\n\nThis concludes the one-time preparation. Now you can extend and modify your\nTerraform configuration as usual.\n\n### Destroy\n\nFollow this procedure to delete your deployment.\n\n1. In `main.tf`, change the `terraform_state_backend` module arguments as\n   follows:\n   ```hcl\n    module \"terraform_state_backend\" {\n      # ...\n      terraform_backend_config_file_path = \"\"\n      force_destroy                      = true\n    }\n    ```\n1. `terraform apply -target module.terraform_state_backend -auto-approve`.\n   This implements the above modifications by deleting the `backend.tf` file\n   and enabling deletion of the S3 state bucket.\n1. `terraform init -force-copy`. Terraform detects that you want to move your\n   Terraform state from the S3 backend to local files, and it does so per\n   `-auto-approve`. Now the state is once again stored locally and the S3\n   state bucket can be safely deleted.\n1. `terraform destroy`. This deletes all resources in your deployment.\n1. Examine local state file `terraform.tfstate` to verify that it contains\n   no resources.\n\n\u003cbr/\u003e\n\n![s3-bucket-with-terraform-state](images/s3-bucket-with-terraform-state.png)\n\n### Bucket Replication (Disaster Recovery)\n\nTo 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.\n\n```hcl\nmodule \"terraform_state_backend\" {\n  source = \"cloudposse/tfstate-backend/aws\"\n  # Cloud Posse recommends pinning every module to a specific version\n  # version     = \"x.x.x\"\n  namespace  = \"eg\"\n  stage      = \"test\"\n  name       = \"terraform\"\n  attributes = [\"state\"]\n\n  terraform_backend_config_file_path = \".\"\n  terraform_backend_config_file_name = \"backend.tf\"\n  force_destroy                      = false\n\n  s3_replication_enabled = true\n  s3_replica_bucket_arn  = \"arn:aws:s3:::eg-test-terraform-tfstate-replica\"\n}\n```\n\n\u003e [!IMPORTANT]\n\u003e In Cloud Posse's examples, we avoid pinning modules to specific versions to prevent discrepancies between the documentation\n\u003e and the latest released versions. However, for your own projects, we strongly advise pinning each module to the exact version\n\u003e you're using. This practice ensures the stability of your infrastructure. Additionally, we recommend implementing a systematic\n\u003e approach for updating versions to avoid unexpected changes.\n\n\n\n\n\n\n\n\n\u003c!-- markdownlint-disable --\u003e\n## Makefile Targets\n```text\nAvailable targets:\n\n  help                                Help screen\n  help/all                            Display help for all targets\n  help/short                          This help short screen\n  lint                                Lint terraform code\n\n```\n\u003c!-- markdownlint-restore --\u003e\n\u003c!-- markdownlint-disable --\u003e\n## Requirements\n\n| Name | Version |\n|------|---------|\n| \u003ca name=\"requirement_terraform\"\u003e\u003c/a\u003e [terraform](#requirement\\_terraform) | \u003e= 1.1.0 |\n| \u003ca name=\"requirement_aws\"\u003e\u003c/a\u003e [aws](#requirement\\_aws) | \u003e= 4.9.0 |\n| \u003ca name=\"requirement_local\"\u003e\u003c/a\u003e [local](#requirement\\_local) | \u003e= 2.0 |\n| \u003ca name=\"requirement_time\"\u003e\u003c/a\u003e [time](#requirement\\_time) | \u003e= 0.7.1 |\n\n## Providers\n\n| Name | Version |\n|------|---------|\n| \u003ca name=\"provider_aws\"\u003e\u003c/a\u003e [aws](#provider\\_aws) | \u003e= 4.9.0 |\n| \u003ca name=\"provider_local\"\u003e\u003c/a\u003e [local](#provider\\_local) | \u003e= 2.0 |\n| \u003ca name=\"provider_time\"\u003e\u003c/a\u003e [time](#provider\\_time) | \u003e= 0.7.1 |\n\n## Modules\n\n| Name | Source | Version |\n|------|--------|---------|\n| \u003ca name=\"module_bucket_label\"\u003e\u003c/a\u003e [bucket\\_label](#module\\_bucket\\_label) | cloudposse/label/null | 0.25.0 |\n| \u003ca name=\"module_dynamodb_table_label\"\u003e\u003c/a\u003e [dynamodb\\_table\\_label](#module\\_dynamodb\\_table\\_label) | cloudposse/label/null | 0.25.0 |\n| \u003ca name=\"module_replication_label\"\u003e\u003c/a\u003e [replication\\_label](#module\\_replication\\_label) | cloudposse/label/null | 0.25.0 |\n| \u003ca name=\"module_this\"\u003e\u003c/a\u003e [this](#module\\_this) | cloudposse/label/null | 0.25.0 |\n\n## Resources\n\n| Name | Type |\n|------|------|\n| [aws_dynamodb_table.with_server_side_encryption](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/dynamodb_table) | resource |\n| [aws_iam_policy.replication](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_policy) | resource |\n| [aws_iam_role.replication](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role) | resource |\n| [aws_iam_role_policy_attachment.replication](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role_policy_attachment) | resource |\n| [aws_s3_bucket.default](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/s3_bucket) | resource |\n| [aws_s3_bucket_acl.default](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/s3_bucket_acl) | resource |\n| [aws_s3_bucket_logging.default](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/s3_bucket_logging) | resource |\n| [aws_s3_bucket_ownership_controls.default](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/s3_bucket_ownership_controls) | resource |\n| [aws_s3_bucket_policy.default](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/s3_bucket_policy) | resource |\n| [aws_s3_bucket_public_access_block.default](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/s3_bucket_public_access_block) | resource |\n| [aws_s3_bucket_replication_configuration.replication](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/s3_bucket_replication_configuration) | resource |\n| [aws_s3_bucket_server_side_encryption_configuration.default](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/s3_bucket_server_side_encryption_configuration) | resource |\n| [aws_s3_bucket_versioning.default](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/s3_bucket_versioning) | resource |\n| [local_file.terraform_backend_config](https://registry.terraform.io/providers/hashicorp/local/latest/docs/resources/file) | resource |\n| [time_sleep.wait_for_aws_s3_bucket_settings](https://registry.terraform.io/providers/hashicorp/time/latest/docs/resources/sleep) | resource |\n| [aws_iam_policy_document.aggregated_policy](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) | data source |\n| [aws_iam_policy_document.bucket_policy](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) | data source |\n| [aws_iam_policy_document.replication](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) | data source |\n| [aws_iam_policy_document.replication_sts](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) | data source |\n| [aws_region.current](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/region) | data source |\n\n## Inputs\n\n| Name | Description | Type | Default | Required |\n|------|-------------|------|---------|:--------:|\n| \u003ca name=\"input_acl\"\u003e\u003c/a\u003e [acl](#input\\_acl) | The canned ACL to apply to the S3 bucket | `string` | `\"private\"` | no |\n| \u003ca name=\"input_additional_tag_map\"\u003e\u003c/a\u003e [additional\\_tag\\_map](#input\\_additional\\_tag\\_map) | Additional key-value pairs to add to each map in `tags_as_list_of_maps`. Not added to `tags` or `id`.\u003cbr/\u003eThis is for some rare cases where resources want additional configuration of tags\u003cbr/\u003eand therefore take a list of maps with tag key, value, and additional configuration. | `map(string)` | `{}` | no |\n| \u003ca name=\"input_arn_format\"\u003e\u003c/a\u003e [arn\\_format](#input\\_arn\\_format) | ARN format to be used. May be changed to support deployment in GovCloud/China regions. | `string` | `\"arn:aws\"` | no |\n| \u003ca name=\"input_attributes\"\u003e\u003c/a\u003e [attributes](#input\\_attributes) | ID element. Additional attributes (e.g. `workers` or `cluster`) to add to `id`,\u003cbr/\u003ein the order they appear in the list. New attributes are appended to the\u003cbr/\u003eend of the list. The elements of the list are joined by the `delimiter`\u003cbr/\u003eand treated as a single ID element. | `list(string)` | `[]` | no |\n| \u003ca name=\"input_billing_mode\"\u003e\u003c/a\u003e [billing\\_mode](#input\\_billing\\_mode) | DynamoDB billing mode | `string` | `\"PAY_PER_REQUEST\"` | no |\n| \u003ca name=\"input_block_public_acls\"\u003e\u003c/a\u003e [block\\_public\\_acls](#input\\_block\\_public\\_acls) | Whether Amazon S3 should block public ACLs for this bucket | `bool` | `true` | no |\n| \u003ca name=\"input_block_public_policy\"\u003e\u003c/a\u003e [block\\_public\\_policy](#input\\_block\\_public\\_policy) | Whether Amazon S3 should block public bucket policies for this bucket | `bool` | `true` | no |\n| \u003ca name=\"input_bucket_enabled\"\u003e\u003c/a\u003e [bucket\\_enabled](#input\\_bucket\\_enabled) | Whether to create the S3 bucket. | `bool` | `true` | no |\n| \u003ca name=\"input_bucket_ownership_enforced_enabled\"\u003e\u003c/a\u003e [bucket\\_ownership\\_enforced\\_enabled](#input\\_bucket\\_ownership\\_enforced\\_enabled) | Set bucket object ownership to \"BucketOwnerEnforced\". Disables ACLs. | `bool` | `true` | no |\n| \u003ca name=\"input_context\"\u003e\u003c/a\u003e [context](#input\\_context) | Single object for setting entire context at once.\u003cbr/\u003eSee description of individual variables for details.\u003cbr/\u003eLeave string and numeric variables as `null` to use default value.\u003cbr/\u003eIndividual variable settings (non-null) override settings in context object,\u003cbr/\u003eexcept for attributes, tags, and additional\\_tag\\_map, which are merged. | `any` | \u003cpre\u003e{\u003cbr/\u003e  \"additional_tag_map\": {},\u003cbr/\u003e  \"attributes\": [],\u003cbr/\u003e  \"delimiter\": null,\u003cbr/\u003e  \"descriptor_formats\": {},\u003cbr/\u003e  \"enabled\": true,\u003cbr/\u003e  \"environment\": null,\u003cbr/\u003e  \"id_length_limit\": null,\u003cbr/\u003e  \"label_key_case\": null,\u003cbr/\u003e  \"label_order\": [],\u003cbr/\u003e  \"label_value_case\": null,\u003cbr/\u003e  \"labels_as_tags\": [\u003cbr/\u003e    \"unset\"\u003cbr/\u003e  ],\u003cbr/\u003e  \"name\": null,\u003cbr/\u003e  \"namespace\": null,\u003cbr/\u003e  \"regex_replace_chars\": null,\u003cbr/\u003e  \"stage\": null,\u003cbr/\u003e  \"tags\": {},\u003cbr/\u003e  \"tenant\": null\u003cbr/\u003e}\u003c/pre\u003e | no |\n| \u003ca name=\"input_deletion_protection_enabled\"\u003e\u003c/a\u003e [deletion\\_protection\\_enabled](#input\\_deletion\\_protection\\_enabled) | A boolean that enables deletion protection for DynamoDB table | `bool` | `false` | no |\n| \u003ca name=\"input_delimiter\"\u003e\u003c/a\u003e [delimiter](#input\\_delimiter) | Delimiter to be used between ID elements.\u003cbr/\u003eDefaults to `-` (hyphen). Set to `\"\"` to use no delimiter at all. | `string` | `null` | no |\n| \u003ca name=\"input_descriptor_formats\"\u003e\u003c/a\u003e [descriptor\\_formats](#input\\_descriptor\\_formats) | Describe additional descriptors to be output in the `descriptors` output map.\u003cbr/\u003eMap of maps. Keys are names of descriptors. Values are maps of the form\u003cbr/\u003e`{\u003cbr/\u003e   format = string\u003cbr/\u003e   labels = list(string)\u003cbr/\u003e}`\u003cbr/\u003e(Type is `any` so the map values can later be enhanced to provide additional options.)\u003cbr/\u003e`format` is a Terraform format string to be passed to the `format()` function.\u003cbr/\u003e`labels` is a list of labels, in order, to pass to `format()` function.\u003cbr/\u003eLabel values will be normalized before being passed to `format()` so they will be\u003cbr/\u003eidentical to how they appear in `id`.\u003cbr/\u003eDefault is `{}` (`descriptors` output will be empty). | `any` | `{}` | no |\n| \u003ca name=\"input_dynamodb_enabled\"\u003e\u003c/a\u003e [dynamodb\\_enabled](#input\\_dynamodb\\_enabled) | Whether to create the DynamoDB table. | `bool` | `true` | no |\n| \u003ca name=\"input_dynamodb_table_name\"\u003e\u003c/a\u003e [dynamodb\\_table\\_name](#input\\_dynamodb\\_table\\_name) | Override the name of the DynamoDB table which defaults to using `module.dynamodb_table_label.id` | `string` | `null` | no |\n| \u003ca name=\"input_enable_point_in_time_recovery\"\u003e\u003c/a\u003e [enable\\_point\\_in\\_time\\_recovery](#input\\_enable\\_point\\_in\\_time\\_recovery) | Enable DynamoDB point-in-time recovery | `bool` | `true` | no |\n| \u003ca name=\"input_enable_public_access_block\"\u003e\u003c/a\u003e [enable\\_public\\_access\\_block](#input\\_enable\\_public\\_access\\_block) | Enable Bucket Public Access Block | `bool` | `true` | no |\n| \u003ca name=\"input_enabled\"\u003e\u003c/a\u003e [enabled](#input\\_enabled) | Set to false to prevent the module from creating any resources | `bool` | `null` | no |\n| \u003ca name=\"input_environment\"\u003e\u003c/a\u003e [environment](#input\\_environment) | ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT' | `string` | `null` | no |\n| \u003ca name=\"input_force_destroy\"\u003e\u003c/a\u003e [force\\_destroy](#input\\_force\\_destroy) | A boolean that indicates the S3 bucket can be destroyed even if it contains objects. These objects are not recoverable | `bool` | `false` | no |\n| \u003ca name=\"input_id_length_limit\"\u003e\u003c/a\u003e [id\\_length\\_limit](#input\\_id\\_length\\_limit) | Limit `id` to this many characters (minimum 6).\u003cbr/\u003eSet to `0` for unlimited length.\u003cbr/\u003eSet to `null` for keep the existing setting, which defaults to `0`.\u003cbr/\u003eDoes not affect `id_full`. | `number` | `null` | no |\n| \u003ca name=\"input_ignore_public_acls\"\u003e\u003c/a\u003e [ignore\\_public\\_acls](#input\\_ignore\\_public\\_acls) | Whether Amazon S3 should ignore public ACLs for this bucket | `bool` | `true` | no |\n| \u003ca name=\"input_kms_master_key_id\"\u003e\u003c/a\u003e [kms\\_master\\_key\\_id](#input\\_kms\\_master\\_key\\_id) | AWS KMS master key ID used for the SSE-KMS encryption.\u003cbr/\u003eThis can only be used when you set the value of sse\\_algorithm as aws:kms. | `string` | `null` | no |\n| \u003ca name=\"input_label_key_case\"\u003e\u003c/a\u003e [label\\_key\\_case](#input\\_label\\_key\\_case) | Controls the letter case of the `tags` keys (label names) for tags generated by this module.\u003cbr/\u003eDoes not affect keys of tags passed in via the `tags` input.\u003cbr/\u003ePossible values: `lower`, `title`, `upper`.\u003cbr/\u003eDefault value: `title`. | `string` | `null` | no |\n| \u003ca name=\"input_label_order\"\u003e\u003c/a\u003e [label\\_order](#input\\_label\\_order) | The order in which the labels (ID elements) appear in the `id`.\u003cbr/\u003eDefaults to [\"namespace\", \"environment\", \"stage\", \"name\", \"attributes\"].\u003cbr/\u003eYou can omit any of the 6 labels (\"tenant\" is the 6th), but at least one must be present. | `list(string)` | `null` | no |\n| \u003ca name=\"input_label_value_case\"\u003e\u003c/a\u003e [label\\_value\\_case](#input\\_label\\_value\\_case) | Controls the letter case of ID elements (labels) as included in `id`,\u003cbr/\u003eset as tag values, and output by this module individually.\u003cbr/\u003eDoes not affect values of tags passed in via the `tags` input.\u003cbr/\u003ePossible values: `lower`, `title`, `upper` and `none` (no transformation).\u003cbr/\u003eSet this to `title` and set `delimiter` to `\"\"` to yield Pascal Case IDs.\u003cbr/\u003eDefault value: `lower`. | `string` | `null` | no |\n| \u003ca name=\"input_labels_as_tags\"\u003e\u003c/a\u003e [labels\\_as\\_tags](#input\\_labels\\_as\\_tags) | Set of labels (ID elements) to include as tags in the `tags` output.\u003cbr/\u003eDefault is to include all labels.\u003cbr/\u003eTags with empty values will not be included in the `tags` output.\u003cbr/\u003eSet to `[]` to suppress all generated tags.\u003cbr/\u003e**Notes:**\u003cbr/\u003e  The value of the `name` tag, if included, will be the `id`, not the `name`.\u003cbr/\u003e  Unlike other `null-label` inputs, the initial setting of `labels_as_tags` cannot be\u003cbr/\u003e  changed in later chained modules. Attempts to change it will be silently ignored. | `set(string)` | \u003cpre\u003e[\u003cbr/\u003e  \"default\"\u003cbr/\u003e]\u003c/pre\u003e | no |\n| \u003ca name=\"input_logging\"\u003e\u003c/a\u003e [logging](#input\\_logging) | Destination (S3 bucket name and prefix) for S3 Server Access Logs for the S3 bucket. | \u003cpre\u003elist(object({\u003cbr/\u003e    target_bucket = string\u003cbr/\u003e    target_prefix = string\u003cbr/\u003e  }))\u003c/pre\u003e | `[]` | no |\n| \u003ca name=\"input_mfa_delete\"\u003e\u003c/a\u003e [mfa\\_delete](#input\\_mfa\\_delete) | A boolean that indicates that versions of S3 objects can only be deleted with MFA. ( Terraform cannot apply changes of this value; https://github.com/terraform-providers/terraform-provider-aws/issues/629 ) | `bool` | `false` | no |\n| \u003ca name=\"input_name\"\u003e\u003c/a\u003e [name](#input\\_name) | ID element. Usually the component or solution name, e.g. 'app' or 'jenkins'.\u003cbr/\u003eThis is the only ID element not also included as a `tag`.\u003cbr/\u003eThe \"name\" tag is set to the full `id` string. There is no tag with the value of the `name` input. | `string` | `null` | no |\n| \u003ca name=\"input_namespace\"\u003e\u003c/a\u003e [namespace](#input\\_namespace) | ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique | `string` | `null` | no |\n| \u003ca name=\"input_permissions_boundary\"\u003e\u003c/a\u003e [permissions\\_boundary](#input\\_permissions\\_boundary) | ARN of the policy that is used to set the permissions boundary for the IAM replication role | `string` | `\"\"` | no |\n| \u003ca name=\"input_prevent_unencrypted_uploads\"\u003e\u003c/a\u003e [prevent\\_unencrypted\\_uploads](#input\\_prevent\\_unencrypted\\_uploads) | Prevent uploads of unencrypted objects to S3 | `bool` | `true` | no |\n| \u003ca name=\"input_profile\"\u003e\u003c/a\u003e [profile](#input\\_profile) | AWS profile name as set in the shared credentials file | `string` | `\"\"` | no |\n| \u003ca name=\"input_read_capacity\"\u003e\u003c/a\u003e [read\\_capacity](#input\\_read\\_capacity) | DynamoDB read capacity units when using provisioned mode | `number` | `5` | no |\n| \u003ca name=\"input_regex_replace_chars\"\u003e\u003c/a\u003e [regex\\_replace\\_chars](#input\\_regex\\_replace\\_chars) | Terraform regular expression (regex) string.\u003cbr/\u003eCharacters matching the regex will be removed from the ID elements.\u003cbr/\u003eIf not set, `\"/[^a-zA-Z0-9-]/\"` is used to remove all characters other than hyphens, letters and digits. | `string` | `null` | no |\n| \u003ca name=\"input_restrict_public_buckets\"\u003e\u003c/a\u003e [restrict\\_public\\_buckets](#input\\_restrict\\_public\\_buckets) | Whether Amazon S3 should restrict public bucket policies for this bucket | `bool` | `true` | no |\n| \u003ca name=\"input_role_arn\"\u003e\u003c/a\u003e [role\\_arn](#input\\_role\\_arn) | The role to be assumed | `string` | `\"\"` | no |\n| \u003ca name=\"input_s3_bucket_name\"\u003e\u003c/a\u003e [s3\\_bucket\\_name](#input\\_s3\\_bucket\\_name) | S3 bucket name. If not provided, the name will be generated from the context by the label module. | `string` | `\"\"` | no |\n| \u003ca name=\"input_s3_replica_bucket_arn\"\u003e\u003c/a\u003e [s3\\_replica\\_bucket\\_arn](#input\\_s3\\_replica\\_bucket\\_arn) | The ARN of the S3 replica bucket (destination) | `string` | `\"\"` | no |\n| \u003ca name=\"input_s3_replication_enabled\"\u003e\u003c/a\u003e [s3\\_replication\\_enabled](#input\\_s3\\_replication\\_enabled) | Set this to true and specify `s3_replica_bucket_arn` to enable replication | `bool` | `false` | no |\n| \u003ca name=\"input_source_policy_documents\"\u003e\u003c/a\u003e [source\\_policy\\_documents](#input\\_source\\_policy\\_documents) | List of IAM policy documents (in JSON format) that are merged together into the generated S3 bucket policy.\u003cbr/\u003eStatements must have unique SIDs.\u003cbr/\u003eStatement having SIDs that match policy SIDs generated by this module will override them. | `list(string)` | `[]` | no |\n| \u003ca name=\"input_sse_encryption\"\u003e\u003c/a\u003e [sse\\_encryption](#input\\_sse\\_encryption) | The server-side encryption algorithm to use.\u003cbr/\u003eValid values are `AES256`, `aws:kms`, and `aws:kms:dsse`. | `string` | `\"AES256\"` | no |\n| \u003ca name=\"input_stage\"\u003e\u003c/a\u003e [stage](#input\\_stage) | ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release' | `string` | `null` | no |\n| \u003ca name=\"input_tags\"\u003e\u003c/a\u003e [tags](#input\\_tags) | Additional tags (e.g. `{'BusinessUnit': 'XYZ'}`).\u003cbr/\u003eNeither the tag keys nor the tag values will be modified by this module. | `map(string)` | `{}` | no |\n| \u003ca name=\"input_tenant\"\u003e\u003c/a\u003e [tenant](#input\\_tenant) | ID element \\_(Rarely used, not included by default)\\_. A customer identifier, indicating who this instance of a resource is for | `string` | `null` | no |\n| \u003ca name=\"input_terraform_backend_config_file_name\"\u003e\u003c/a\u003e [terraform\\_backend\\_config\\_file\\_name](#input\\_terraform\\_backend\\_config\\_file\\_name) | (Deprecated) Name of terraform backend config file to generate | `string` | `\"terraform.tf\"` | no |\n| \u003ca name=\"input_terraform_backend_config_file_path\"\u003e\u003c/a\u003e [terraform\\_backend\\_config\\_file\\_path](#input\\_terraform\\_backend\\_config\\_file\\_path) | (Deprecated) Directory for the terraform backend config file, usually `.`. The default is to create no file. | `string` | `\"\"` | no |\n| \u003ca name=\"input_terraform_backend_config_template_file\"\u003e\u003c/a\u003e [terraform\\_backend\\_config\\_template\\_file](#input\\_terraform\\_backend\\_config\\_template\\_file) | (Deprecated) The path to the template used to generate the config file | `string` | `\"\"` | no |\n| \u003ca name=\"input_terraform_state_file\"\u003e\u003c/a\u003e [terraform\\_state\\_file](#input\\_terraform\\_state\\_file) | The path to the state file inside the bucket | `string` | `\"terraform.tfstate\"` | no |\n| \u003ca name=\"input_terraform_version\"\u003e\u003c/a\u003e [terraform\\_version](#input\\_terraform\\_version) | The minimum required terraform version | `string` | `\"1.0.0\"` | no |\n| \u003ca name=\"input_write_capacity\"\u003e\u003c/a\u003e [write\\_capacity](#input\\_write\\_capacity) | DynamoDB write capacity units when using provisioned mode | `number` | `5` | no |\n\n## Outputs\n\n| Name | Description |\n|------|-------------|\n| \u003ca name=\"output_dynamodb_table_arn\"\u003e\u003c/a\u003e [dynamodb\\_table\\_arn](#output\\_dynamodb\\_table\\_arn) | DynamoDB table ARN |\n| \u003ca name=\"output_dynamodb_table_id\"\u003e\u003c/a\u003e [dynamodb\\_table\\_id](#output\\_dynamodb\\_table\\_id) | DynamoDB table ID |\n| \u003ca name=\"output_dynamodb_table_name\"\u003e\u003c/a\u003e [dynamodb\\_table\\_name](#output\\_dynamodb\\_table\\_name) | DynamoDB table name |\n| \u003ca name=\"output_s3_bucket_arn\"\u003e\u003c/a\u003e [s3\\_bucket\\_arn](#output\\_s3\\_bucket\\_arn) | S3 bucket ARN |\n| \u003ca name=\"output_s3_bucket_domain_name\"\u003e\u003c/a\u003e [s3\\_bucket\\_domain\\_name](#output\\_s3\\_bucket\\_domain\\_name) | S3 bucket domain name |\n| \u003ca name=\"output_s3_bucket_id\"\u003e\u003c/a\u003e [s3\\_bucket\\_id](#output\\_s3\\_bucket\\_id) | S3 bucket ID |\n| \u003ca name=\"output_s3_replication_role_arn\"\u003e\u003c/a\u003e [s3\\_replication\\_role\\_arn](#output\\_s3\\_replication\\_role\\_arn) | The ARN of the IAM Role created for replication, if enabled. |\n| \u003ca name=\"output_terraform_backend_config\"\u003e\u003c/a\u003e [terraform\\_backend\\_config](#output\\_terraform\\_backend\\_config) | Rendered Terraform backend config file |\n\u003c!-- markdownlint-restore --\u003e\n\n\n## Related Projects\n\nCheck out these related projects.\n\n- [terraform-aws-dynamodb](https://github.com/cloudposse/terraform-aws-dynamodb) - Terraform module that implements AWS DynamoDB with support for AutoScaling\n- [terraform-aws-dynamodb-autoscaler](https://github.com/cloudposse/terraform-aws-dynamodb-autoscaler) - Terraform module to provision DynamoDB autoscaler\n\n\n\u003e [!TIP]\n\u003e #### Use Terraform Reference Architectures for AWS\n\u003e\n\u003e Use Cloud Posse's ready-to-go [terraform architecture blueprints](https://cloudposse.com/reference-architecture/) for AWS to get up and running quickly.\n\u003e\n\u003e ✅ We build it together with your team.\u003cbr/\u003e\n\u003e ✅ Your team owns everything.\u003cbr/\u003e\n\u003e ✅ 100% Open Source and backed by fanatical support.\u003cbr/\u003e\n\u003e\n\u003e \u003ca href=\"https://cpco.io/commercial-support?utm_source=github\u0026utm_medium=readme\u0026utm_campaign=cloudposse/terraform-aws-tfstate-backend\u0026utm_content=commercial_support\"\u003e\u003cimg alt=\"Request Quote\" src=\"https://img.shields.io/badge/request%20quote-success.svg?style=for-the-badge\"/\u003e\u003c/a\u003e\n\u003e \u003cdetails\u003e\u003csummary\u003e📚 \u003cstrong\u003eLearn More\u003c/strong\u003e\u003c/summary\u003e\n\u003e\n\u003e \u003cbr/\u003e\n\u003e\n\u003e Cloud Posse is the leading [**DevOps Accelerator**](https://cpco.io/commercial-support?utm_source=github\u0026utm_medium=readme\u0026utm_campaign=cloudposse/terraform-aws-tfstate-backend\u0026utm_content=commercial_support) for funded startups and enterprises.\n\u003e\n\u003e *Your team can operate like a pro today.*\n\u003e\n\u003e Ensure that your team succeeds by using Cloud Posse's proven process and turnkey blueprints. Plus, we stick around until you succeed.\n\u003e #### Day-0:  Your Foundation for Success\n\u003e - **Reference Architecture.** You'll get everything you need from the ground up built using 100% infrastructure as code.\n\u003e - **Deployment Strategy.** Adopt a proven deployment strategy with GitHub Actions, enabling automated, repeatable, and reliable software releases.\n\u003e - **Site Reliability Engineering.** Gain total visibility into your applications and services with Datadog, ensuring high availability and performance.\n\u003e - **Security Baseline.** Establish a secure environment from the start, with built-in governance, accountability, and comprehensive audit logs, safeguarding your operations.\n\u003e - **GitOps.** Empower your team to manage infrastructure changes confidently and efficiently through Pull Requests, leveraging the full power of GitHub Actions.\n\u003e\n\u003e \u003ca href=\"https://cpco.io/commercial-support?utm_source=github\u0026utm_medium=readme\u0026utm_campaign=cloudposse/terraform-aws-tfstate-backend\u0026utm_content=commercial_support\"\u003e\u003cimg alt=\"Request Quote\" src=\"https://img.shields.io/badge/request%20quote-success.svg?style=for-the-badge\"/\u003e\u003c/a\u003e\n\u003e\n\u003e #### Day-2: Your Operational Mastery\n\u003e - **Training.** Equip your team with the knowledge and skills to confidently manage the infrastructure, ensuring long-term success and self-sufficiency.\n\u003e - **Support.** Benefit from a seamless communication over Slack with our experts, ensuring you have the support you need, whenever you need it.\n\u003e - **Troubleshooting.** Access expert assistance to quickly resolve any operational challenges, minimizing downtime and maintaining business continuity.\n\u003e - **Code Reviews.** Enhance your team’s code quality with our expert feedback, fostering continuous improvement and collaboration.\n\u003e - **Bug Fixes.** Rely on our team to troubleshoot and resolve any issues, ensuring your systems run smoothly.\n\u003e - **Migration Assistance.** Accelerate your migration process with our dedicated support, minimizing disruption and speeding up time-to-value.\n\u003e - **Customer Workshops.** Engage with our team in weekly workshops, gaining insights and strategies to continuously improve and innovate.\n\u003e\n\u003e \u003ca href=\"https://cpco.io/commercial-support?utm_source=github\u0026utm_medium=readme\u0026utm_campaign=cloudposse/terraform-aws-tfstate-backend\u0026utm_content=commercial_support\"\u003e\u003cimg alt=\"Request Quote\" src=\"https://img.shields.io/badge/request%20quote-success.svg?style=for-the-badge\"/\u003e\u003c/a\u003e\n\u003e \u003c/details\u003e\n\n## ✨ Contributing\n\nThis project is under active development, and we encourage contributions from our community.\n\n\n\nMany thanks to our outstanding contributors:\n\n\u003ca href=\"https://github.com/cloudposse/terraform-aws-tfstate-backend/graphs/contributors\"\u003e\n  \u003cimg src=\"https://contrib.rocks/image?repo=cloudposse/terraform-aws-tfstate-backend\u0026max=24\" /\u003e\n\u003c/a\u003e\n\nFor 🐛 bug reports \u0026 feature requests, please use the [issue tracker](https://github.com/cloudposse/terraform-aws-tfstate-backend/issues).\n\nIn general, PRs are welcome. We follow the typical \"fork-and-pull\" Git workflow.\n 1. Review our [Code of Conduct](https://github.com/cloudposse/terraform-aws-tfstate-backend/?tab=coc-ov-file#code-of-conduct) and [Contributor Guidelines](https://github.com/cloudposse/.github/blob/main/CONTRIBUTING.md).\n 2. **Fork** the repo on GitHub\n 3. **Clone** the project to your own machine\n 4. **Commit** changes to your own branch\n 5. **Push** your work back up to your fork\n 6. Submit a **Pull Request** so that we can review your changes\n\n**NOTE:** Be sure to merge the latest changes from \"upstream\" before making a pull request!\n\n### 🌎 Slack Community\n\nJoin our [Open Source Community](https://cpco.io/slack?utm_source=github\u0026utm_medium=readme\u0026utm_campaign=cloudposse/terraform-aws-tfstate-backend\u0026utm_content=slack) on Slack. It's **FREE** for everyone! Our \"SweetOps\" community is where you get to talk with others who share a similar vision for how to rollout and manage infrastructure. This is the best place to talk shop, ask questions, solicit feedback, and work together as a community to build totally *sweet* infrastructure.\n\n### 📰 Newsletter\n\nSign up for [our newsletter](https://cpco.io/newsletter?utm_source=github\u0026utm_medium=readme\u0026utm_campaign=cloudposse/terraform-aws-tfstate-backend\u0026utm_content=newsletter) and join 3,000+ DevOps engineers, CTOs, and founders who get insider access to the latest DevOps trends, so you can always stay in the know.\nDropped straight into your Inbox every week — and usually a 5-minute read.\n\n### 📆 Office Hours \u003ca href=\"https://cloudposse.com/office-hours?utm_source=github\u0026utm_medium=readme\u0026utm_campaign=cloudposse/terraform-aws-tfstate-backend\u0026utm_content=office_hours\"\u003e\u003cimg src=\"https://img.cloudposse.com/fit-in/200x200/https://cloudposse.com/wp-content/uploads/2019/08/Powered-by-Zoom.png\" align=\"right\" /\u003e\u003c/a\u003e\n\n[Join us every Wednesday via Zoom](https://cloudposse.com/office-hours?utm_source=github\u0026utm_medium=readme\u0026utm_campaign=cloudposse/terraform-aws-tfstate-backend\u0026utm_content=office_hours) for your weekly dose of insider DevOps trends, AWS news and Terraform insights, all sourced from our SweetOps community, plus a _live Q\u0026A_ that you can’t find anywhere else.\nIt's **FREE** for everyone!\n## License\n\n\u003ca href=\"https://opensource.org/licenses/Apache-2.0\"\u003e\u003cimg src=\"https://img.shields.io/badge/License-Apache%202.0-blue.svg?style=for-the-badge\" alt=\"License\"\u003e\u003c/a\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003ePreamble to the Apache License, Version 2.0\u003c/summary\u003e\n\u003cbr/\u003e\n\u003cbr/\u003e\n\nComplete license is available in the [`LICENSE`](LICENSE) file.\n\n```text\nLicensed to the Apache Software Foundation (ASF) under one\nor more contributor license agreements.  See the NOTICE file\ndistributed with this work for additional information\nregarding copyright ownership.  The ASF licenses this file\nto you under the Apache License, Version 2.0 (the\n\"License\"); you may not use this file except in compliance\nwith the License.  You may obtain a copy of the License at\n\n  https://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing,\nsoftware distributed under the License is distributed on an\n\"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY\nKIND, either express or implied.  See the License for the\nspecific language governing permissions and limitations\nunder the License.\n```\n\u003c/details\u003e\n\n## Trademarks\n\nAll other trademarks referenced herein are the property of their respective owners.\n\n\n---\nCopyright © 2017-2025 [Cloud Posse, LLC](https://cpco.io/copyright)\n\n\n\u003ca href=\"https://cloudposse.com/readme/footer/link?utm_source=github\u0026utm_medium=readme\u0026utm_campaign=cloudposse/terraform-aws-tfstate-backend\u0026utm_content=readme_footer_link\"\u003e\u003cimg alt=\"README footer\" src=\"https://cloudposse.com/readme/footer/img\"/\u003e\u003c/a\u003e\n\n\u003cimg alt=\"Beacon\" width=\"0\" src=\"https://ga-beacon.cloudposse.com/UA-76589703-4/cloudposse/terraform-aws-tfstate-backend?pixel\u0026cs=github\u0026cm=readme\u0026an=terraform-aws-tfstate-backend\"/\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcloudposse%2Fterraform-aws-tfstate-backend","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcloudposse%2Fterraform-aws-tfstate-backend","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcloudposse%2Fterraform-aws-tfstate-backend/lists"}