AWS Backend Module

This module creates an AWS backend for OpenTofu.

Usage

Note

These steps must be completed before adding the backend configuration to your main.tf file.

Add this module to your main.tf (or appropriate) file and configure the inputs to match your desired configuration. For example:

module "backend" {
  source = "github.com/codeforamerica/tofu-modules-aws-backend?ref=1.0.0"

  project     = "my-project"
  environment = "dev"
}

Run the following commands to create the backend:

tofu init
tofu plan -out backend.tfplan
# Make sure to review the plan before applying!
tofu apply backend.tfplan
rm backend.tfplan

Add the backend configuration to your main.tf file:

terraform {
  backend "s3" {
    bucket = "my-project-dev-tfstate"
    key    = "my-project.tfstate" # Choose an appropriate key
    region = "us-east-1"
  }
}

Run the following commands to initialize the backend and transfer the state file.

tofu init -migrate-state

Follow the prompts to migrate the state file. Once complete, you can remove the local state files:

rm terraform.tfstate terraform.tfstate.backup

You now have a fully configured AWS backend for your project!

Inputs

Name	Description	Type	Default	Required
project	The name of the project.	string	n/a	yes
bucket_suffix	Adds a random suffix to the bucket name to ensure its uniqueness.	bool	false	no
environment	The environment for the project.	string	"dev"	no
force_delete	Force delete resources on destroy. This must be set to true and applied before resources can be destroyed.	bool	false	no
key_recovery_period	The number of days to retain the KMS key for recovery after deletion.	number	30	no
state_version_expiration	Age (in days) before non-current versions of the state file are expired.	number	30	no
tags	Optional tags to be applied to all resources.	list	[]	no

Outputs

Name	Description	Type
bucket	Name of the S3 bucket for state storage.	string
kms_key	KMS key used to encrypt state.	string