Terraform module to provision an S3 bucket to store terraform.tfstate
file and a DynamoDB table to lock the state file
to prevent concurrent modifications and state corruption.
The module supports the following:
- Forced server-side encryption at rest for the S3 bucket
- S3 bucket versioning to allow for Terraform state recovery in the case of accidental deletions and human errors
- State locking and consistency checking via DynamoDB table to prevent concurrent operations
- DynamoDB server-side encryption
https://www.terraform.io/docs/backends/types/s3.html
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
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: hashicorp/terraform-provider-aws#62
This project is part of our comprehensive "SweetOps" approach towards DevOps.
It's 100% Open Source and licensed under the APACHE2.
We literally have hundreds of terraform modules that are Open Source and well-maintained. Check them out!
Security scanning is graciously provided by Bridgecrew. Bridgecrew is the leading fully hosted, cloud-native solution providing continuous Terraform security and compliance.
IMPORTANT: We do not pin modules to versions in our examples because of the difficulty of keeping the versions in the documentation in sync with the latest released versions. We highly recommend that in your code you pin the version to the exact version you are using so that your infrastructure remains stable, and update versions in a systematic way so that they do not catch you by surprise.
Also, because of a bug in the Terraform registry (hashicorp/terraform#21417), the registry shows many of our inputs as required when in fact they are optional. The table below correctly indicates which inputs are required.
Follow this procedure just once to create your deployment.
-
Add the
terraform_state_backend
module to yourmain.tf
file. The comment will help you remember to follow this procedure in the future:# You cannot create a new backend by simply defining this and then # immediately proceeding to "terraform apply". The S3 backend must # be bootstrapped according to the simple yet essential procedure in # https://github.com/cloudposse/terraform-aws-tfstate-backend#usage module "terraform_state_backend" { source = "cloudposse/tfstate-backend/aws" # Cloud Posse recommends pinning every module to a specific version # version = "x.x.x" namespace = "eg" stage = "test" name = "terraform" attributes = ["state"] terraform_backend_config_file_path = "." terraform_backend_config_file_name = "backend.tf" force_destroy = false } # Your Terraform configuration module "another_module" { source = "....." }
Module inputs
terraform_backend_config_file_path
andterraform_backend_config_file_name
control the name of the backend definition file. Note that whenterraform_backend_config_file_path
is empty (the default), no file is created. -
terraform init
. This downloads Terraform modules and providers. -
terraform apply -auto-approve
. This creates the state bucket and DynamoDB locking table, along with anything else you have defined in your*.tf
file(s). At this point, the Terraform state is still stored locally.Module
terraform_state_backend
also creates a newbackend.tf
file that defines the S3 state backend. For example:backend "s3" { region = "us-east-1" bucket = "< the name of the S3 state bucket >" key = "terraform.tfstate" dynamodb_table = "< the name of the DynamoDB locking table >" profile = "" role_arn = "" encrypt = true }
Henceforth, Terraform will also read this newly-created backend definition file.
-
terraform init -force-copy
. Terraform detects that you want to move your Terraform state to the S3 backend, and it does so per-auto-approve
. Now the state is stored in the S3 bucket, and the DynamoDB table will be used to lock the state to prevent concurrent modification.
This concludes the one-time preparation. Now you can extend and modify your Terraform configuration as usual.
Follow this procedure to delete your deployment.
- In
main.tf
, change theterraform_state_backend
module arguments as follows:module "terraform_state_backend" { ... terraform_backend_config_file_path = "" force_destroy = true }
terraform apply -target module.terraform_state_backend -auto-approve
. This implements the above modifications by deleting thebackend.tf
file and enabling deletion of the S3 state bucket.terraform init -force-copy
. Terraform detects that you want to move your Terraform state from the S3 backend to local files, and it does so per-auto-approve
. Now the state is once again stored locally and the S3 state bucket can be safely deleted.terraform destroy
. This deletes all resources in your deployment.- Examine local state file
terraform.tfstate
to verify that it contains no resources.
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.
module "terraform_state_backend" {
source = "cloudposse/tfstate-backend/aws"
# Cloud Posse recommends pinning every module to a specific version
# version = "x.x.x"
namespace = "eg"
stage = "test"
name = "terraform"
attributes = ["state"]
terraform_backend_config_file_path = "."
terraform_backend_config_file_name = "backend.tf"
force_destroy = false
s3_replication_enabled = true
s3_replica_bucket_arn = "arn:aws:s3:::eg-test-terraform-tfstate-replica"
}
Available targets:
help Help screen
help/all Display help for all targets
help/short This help short screen
lint Lint terraform code
Name | Version |
---|---|
terraform | >= 0.13.0 |
aws | >= 2.0 |
local | >= 1.3 |
Name | Version |
---|---|
aws | >= 2.0 |
local | >= 1.3 |
Name | Source | Version |
---|---|---|
dynamodb_table_label | cloudposse/label/null | 0.25.0 |
log_storage | cloudposse/s3-log-storage/aws | 0.26.0 |
this | cloudposse/label/null | 0.25.0 |
Name | Type |
---|---|
aws_dynamodb_table.with_server_side_encryption | resource |
aws_dynamodb_table.without_server_side_encryption | resource |
aws_iam_policy.replication | resource |
aws_iam_role.replication | resource |
aws_iam_role_policy_attachment.replication | resource |
aws_s3_bucket.default | resource |
aws_s3_bucket_public_access_block.default | resource |
local_file.terraform_backend_config | resource |
aws_iam_policy_document.prevent_unencrypted_uploads | data source |
aws_iam_policy_document.replication | data source |
aws_iam_policy_document.replication_sts | data source |
aws_region.current | data source |
Name | Description | Type | Default | Required |
---|---|---|---|---|
acl | The canned ACL to apply to the S3 bucket | string |
"private" |
no |
additional_tag_map | Additional key-value pairs to add to each map in tags_as_list_of_maps . Not added to tags or id .This is for some rare cases where resources want additional configuration of tags and therefore take a list of maps with tag key, value, and additional configuration. |
map(string) |
{} |
no |
arn_format | ARN format to be used. May be changed to support deployment in GovCloud/China regions. | string |
"arn:aws" |
no |
attributes | ID element. Additional attributes (e.g. workers or cluster ) to add to id ,in the order they appear in the list. New attributes are appended to the end of the list. The elements of the list are joined by the delimiter and treated as a single ID element. |
list(string) |
[] |
no |
billing_mode | DynamoDB billing mode | string |
"PROVISIONED" |
no |
block_public_acls | Whether Amazon S3 should block public ACLs for this bucket | bool |
true |
no |
block_public_policy | Whether Amazon S3 should block public bucket policies for this bucket | bool |
true |
no |
bucket_enabled | Whether to create the s3 bucket. | bool |
true |
no |
context | Single object for setting entire context at once. See description of individual variables for details. Leave string and numeric variables as null to use default value.Individual variable settings (non-null) override settings in context object, except for attributes, tags, and additional_tag_map, which are merged. |
any |
{ |
no |
delimiter | Delimiter to be used between ID elements. Defaults to - (hyphen). Set to "" to use no delimiter at all. |
string |
null |
no |
descriptor_formats | Describe additional descriptors to be output in the descriptors output map.Map of maps. Keys are names of descriptors. Values are maps of the form {<br> format = string<br> labels = list(string)<br>} (Type is any so the map values can later be enhanced to provide additional options.)format is a Terraform format string to be passed to the format() function.labels is a list of labels, in order, to pass to format() function.Label values will be normalized before being passed to format() so they will beidentical to how they appear in id .Default is {} (descriptors output will be empty). |
any |
{} |
no |
dynamodb_enabled | Whether to create the dynamodb table. | bool |
true |
no |
dynamodb_table_name | Override the name of the DynamoDB table which defaults to using module.dynamodb_table_label.id |
string |
null |
no |
enable_point_in_time_recovery | Enable DynamoDB point-in-time recovery | bool |
true |
no |
enable_public_access_block | Enable Bucket Public Access Block | bool |
true |
no |
enable_server_side_encryption | Enable DynamoDB server-side encryption | bool |
true |
no |
enabled | Set to false to prevent the module from creating any resources | bool |
null |
no |
environment | ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT' | string |
null |
no |
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 |
id_length_limit | Limit id to this many characters (minimum 6).Set to 0 for unlimited length.Set to null for keep the existing setting, which defaults to 0 .Does not affect id_full . |
number |
null |
no |
ignore_public_acls | Whether Amazon S3 should ignore public ACLs for this bucket | bool |
true |
no |
label_key_case | Controls the letter case of the tags keys (label names) for tags generated by this module.Does not affect keys of tags passed in via the tags input.Possible values: lower , title , upper .Default value: title . |
string |
null |
no |
label_order | The order in which the labels (ID elements) appear in the id .Defaults to ["namespace", "environment", "stage", "name", "attributes"]. You can omit any of the 6 labels ("tenant" is the 6th), but at least one must be present. |
list(string) |
null |
no |
label_value_case | Controls the letter case of ID elements (labels) as included in id ,set as tag values, and output by this module individually. Does not affect values of tags passed in via the tags input.Possible values: lower , title , upper and none (no transformation).Set this to title and set delimiter to "" to yield Pascal Case IDs.Default value: lower . |
string |
null |
no |
labels_as_tags | Set of labels (ID elements) to include as tags in the tags output.Default is to include all labels. Tags with empty values will not be included in the tags output.Set to [] to suppress all generated tags.Notes: The value of the name tag, if included, will be the id , not the name .Unlike other null-label inputs, the initial setting of labels_as_tags cannot bechanged in later chained modules. Attempts to change it will be silently ignored. |
set(string) |
[ |
no |
logging | Bucket access logging configuration. | object({ |
null |
no |
logging_bucket_enabled | Whether to create the s3 access log bucket. | bool |
false |
no |
logging_bucket_expiration_days | Whether to create the s3 access log bucket. | number |
90 |
no |
logging_bucket_glacier_transition_days | Whether to create the s3 access log bucket. | number |
60 |
no |
logging_bucket_standard_transition_days | Whether to create the s3 access log bucket. | number |
30 |
no |
mfa_delete | A boolean that indicates that versions of S3 objects can only be deleted with MFA. ( Terraform cannot apply changes of this value; hashicorp/terraform-provider-aws#629 ) | bool |
false |
no |
name | ID element. Usually the component or solution name, e.g. 'app' or 'jenkins'. This is the only ID element not also included as a tag .The "name" tag is set to the full id string. There is no tag with the value of the name input. |
string |
null |
no |
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 |
prevent_unencrypted_uploads | Prevent uploads of unencrypted objects to S3 | bool |
true |
no |
profile | AWS profile name as set in the shared credentials file | string |
"" |
no |
read_capacity | DynamoDB read capacity units | number |
5 |
no |
regex_replace_chars | Terraform regular expression (regex) string. Characters matching the regex will be removed from the ID elements. If not set, "/[^a-zA-Z0-9-]/" is used to remove all characters other than hyphens, letters and digits. |
string |
null |
no |
restrict_public_buckets | Whether Amazon S3 should restrict public bucket policies for this bucket | bool |
true |
no |
role_arn | The role to be assumed | string |
"" |
no |
s3_bucket_name | S3 bucket name. If not provided, the name will be generated by the label module in the format namespace-stage-name | string |
"" |
no |
s3_replica_bucket_arn | The ARN of the S3 replica bucket (destination) | string |
"" |
no |
s3_replication_enabled | Set this to true and specify s3_replica_bucket_arn to enable replication |
bool |
false |
no |
stage | ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release' | string |
null |
no |
tags | Additional tags (e.g. {'BusinessUnit': 'XYZ'} ).Neither the tag keys nor the tag values will be modified by this module. |
map(string) |
{} |
no |
tenant | ID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is for | string |
null |
no |
terraform_backend_config_file_name | Name of terraform backend config file | string |
"terraform.tf" |
no |
terraform_backend_config_file_path | Directory for the terraform backend config file, usually . . The default is to create no file. |
string |
"" |
no |
terraform_backend_config_template_file | The path to the template used to generate the config file | string |
"" |
no |
terraform_state_file | The path to the state file inside the bucket | string |
"terraform.tfstate" |
no |
terraform_version | The minimum required terraform version | string |
"0.12.2" |
no |
write_capacity | DynamoDB write capacity units | number |
5 |
no |
Name | Description |
---|---|
dynamodb_table_arn | DynamoDB table ARN |
dynamodb_table_id | DynamoDB table ID |
dynamodb_table_name | DynamoDB table name |
s3_bucket_arn | S3 bucket ARN |
s3_bucket_domain_name | S3 bucket domain name |
s3_bucket_id | S3 bucket ID |
terraform_backend_config | Rendered Terraform backend config file |
Like this project? Please give it a ★ on our GitHub! (it helps us a lot)
Are you using this project or any of our other projects? Consider leaving a testimonial. =)
Check out these related projects.
- terraform-aws-dynamodb - Terraform module that implements AWS DynamoDB with support for AutoScaling
- terraform-aws-dynamodb-autoscaler - Terraform module to provision DynamoDB autoscaler
Got a question? We got answers.
File a GitHub issue, send us an email or join our Slack Community.
We are a DevOps Accelerator. We'll help you build your cloud infrastructure from the ground up so you can own it. Then we'll show you how to operate it and stick around for as long as you need us.
Work directly with our team of DevOps experts via email, slack, and video conferencing.
We deliver 10x the value for a fraction of the cost of a full-time engineer. Our track record is not even funny. If you want things done right and you need it done FAST, then we're your best bet.
- Reference Architecture. You'll get everything you need from the ground up built using 100% infrastructure as code.
- Release Engineering. You'll have end-to-end CI/CD with unlimited staging environments.
- Site Reliability Engineering. You'll have total visibility into your apps and microservices.
- Security Baseline. You'll have built-in governance with accountability and audit logs for all changes.
- GitOps. You'll be able to operate your infrastructure via Pull Requests.
- Training. You'll receive hands-on training so your team can operate what we build.
- Questions. You'll have a direct line of communication between our teams via a Shared Slack channel.
- Troubleshooting. You'll get help to triage when things aren't working.
- Code Reviews. You'll receive constructive feedback on Pull Requests.
- Bug Fixes. We'll rapidly work with you to fix any bugs in our projects.
Join our Open Source Community 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.
Participate in our Discourse Forums. Here you'll find answers to commonly asked questions. Most questions will be related to the enormous number of projects we support on our GitHub. Come here to collaborate on answers, find solutions, and get ideas about the products and services we value. It only takes a minute to get started! Just sign in with SSO using your GitHub account.
Sign up for our newsletter that covers everything on our technology radar. Receive updates on what we're up to on GitHub as well as awesome new projects we discover.
Join us every Wednesday via Zoom for our weekly "Lunch & Learn" sessions. It's FREE for everyone!
Please use the issue tracker to report any bugs or file feature requests.
If you are interested in being a contributor and want to get involved in developing this project or help out with our other projects, we would love to hear from you! Shoot us an email.
In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
- Fork the repo on GitHub
- Clone the project to your own machine
- Commit changes to your own branch
- Push your work back up to your fork
- Submit a Pull Request so that we can review your changes
NOTE: Be sure to merge the latest changes from "upstream" before making a pull request!
Copyright © 2017-2021 Cloud Posse, LLC
See LICENSE for full details.
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
https://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
All other trademarks referenced herein are the property of their respective owners.
This project is maintained and funded by Cloud Posse, LLC. Like it? Please let us know by leaving a testimonial!
We're a DevOps Professional Services company based in Los Angeles, CA. We ❤️ Open Source Software.
We offer paid support on all of our projects.
Check out our other projects, follow us on twitter, apply for a job, or hire us to help with your cloud strategy and implementation.
Andriy Knysh |
Erik Osterman |
Maarten van der Hoef |
Vladimir |
Chris Weyl |
John McGehee |
Oliver L Schoenborn |
---|