Skip to content

A cloudformed terraform remote state using Amazon S3, with locking via DynamoDB

License

Notifications You must be signed in to change notification settings

lantrix/terraform-remote-state-s3-cloudformation

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 
 
 
 
 

Repository files navigation

This is a Terraform remote state using AWS S3 & DynamoDB.

Deploy

  • Deploy the cloudformation stack in your region (e.g. ap-southeast-2):
aws cloudformation deploy \
		--stack-name terraform-state \
		--template-file stack.template \
		--region ap-southeast-2 \
		--no-fail-on-empty-changeset
  • Deploy a managed policy to attach to IAM roles:
aws cloudformation deploy \
		--stack-name terraform-state-managed-policy \
		--template-file stack-managed-policy.template \
		--capabilities CAPABILITY_NAMED_IAM \
		--region ap-southeast-2 \
		--no-fail-on-empty-changeset

Usage

  • Initialise your terraform project to reference the state resources
export accountId=$(aws sts get-caller-identity --query Account --output text)
terraform init \
    -backend-config="region=ap-southeast-2" \
    -backend-config="bucket=terraform-state-${accountId}" \
    -backend-config="key=terraform.tfstate" \
    -backend-config="dynamodb_table=terraform-state"
  • Ensure you reference the state in the terraform project. You can use the workspace_key_prefix to differentiate each project in the state store.
terraform {
  required_providers {
    aws = {
      source  = "hashicorp/aws"
      version = "~> 5.0"
    }
  }
  backend "s3" {
    workspace_key_prefix = "my-project" # Prefix used when changing terraform workspaces
    bucket               = "terraform-state-123456789012" # My S3 state bucket name
    key                  = "terraform.tfstate" # S3 keyname of actual state file
    region               = "ap-southeast-2" # Region
    dynamodb_table       = "terraform-state" # Dynamo table name
  }
}

provider "aws" {
  region = "ap-southeast-2"
}

About

A cloudformed terraform remote state using Amazon S3, with locking via DynamoDB

Topics

Resources

License

Stars

Watchers

Forks