Terraform Module Registry

A terraform module to set up remote state management with S3 backend for your account. It creates an encrypted S3 bucket to store state files and a DynamoDB table for state locking and consistency checking. Resources are defined following best practices as described in the official document and ozbillwang/terraform-best-practices.

• Create a S3 bucket to store remote state files.
• Encrypt state files with KMS.
• Enable bucket replication and object versioning to prevent accidental data loss.
• Automatically transit non-current versions in S3 buckets to AWS S3 Glacier to optimize the storage cost.
• Optionally you can set to expire aged non-current versions(disabled by default).
• Create a DynamoDB table for state locking.
• Optionally create an IAM policy to allow permissions which Terraform needs.

The module outputs terraform_iam_policy which can be attached to IAM users, groups or roles running Terraform. This will allow the entity accessing remote state files and the locking table. This can optionally be disabled with terraform_iam_policy_create = false

provider "aws" {
  region = "us-east-1"
}

provider "aws" {
  alias  = "replica"
  region = "us-west-1"
}

module "remote_state" {
  source = "nozaq/remote-state-s3-backend/aws"

  providers = {
    aws         = aws
    aws.replica = aws.replica
  }
}

resource "aws_iam_user" "terraform" {
  name = "TerraformUser"
}

resource "aws_iam_user_policy_attachment" "remote_state_access" {
  user       = aws_iam_user.terraform.name
  policy_arn = module.remote_state.terraform_iam_policy.arn
}

Note that you need to provide two providers, one for the main state bucket and the other for the bucket to which the main state bucket is replicated to. Two providers must point to different AWS regions.

Once resources are created, you can configure your terraform files to use the S3 backend as follows.

terraform {
  backend "s3" {
    bucket  = "THE_NAME_OF_THE_STATE_BUCKET"
    key     = "some_environment/terraform.tfstate"
    region  = "us-east-1"
    encrypt = true
    kms_key_id = "THE_ID_OF_THE_KMS_KEY"
  }
}

THE_NAME_OF_THE_STATE_BUCKET and THE_ID_OF_THE_KMS_KEY can be replaced by state_bucket.bucket and kms_key.id in outputs from this module respectively.

See the official document for more detail.

object({
    days = number
  })

list(object({
    days          = number
    storage_class = string
  }))

[
  {
    "days": 7,
    "storage_class": "GLACIER"
  }
]

{
  "Terraform": "true"
}