Skip to main content

This project provides a CDK construct bootstrapping an AWS account with a S3 Bucket and a DynamoDB table as terraform state backend.

Project description

GitHub npm (scoped) PyPI Nuget Sonatype Nexus (Releases) GitHub Workflow Status (branch) GitHub release (latest SemVer)

AWS CDK Terraform state backend

This project provides a CDK construct bootstrapping an AWS account with a S3 Bucket and a DynamoDB table as Terraform state backend.

Terraform doesn't come shipped with a cli command bootstrapping the account for State Storage and Locking like AWS CDK provides with cdk bootstrap. While bootstrapping the AWS Organization and Accounts this construct may be used to create:

  • S3 Bucket with blocked public access, versioned, encrypted by SSE-S3
  • DynamoDB Table with pay per request, continuous backups using point-in-time recovery, encrypted by AWS owned key
  • IAM Policy with read/write access to the created S3 Bucket and DynamoDB Table

See API.md

Install

TypeScript

npm install @pepperize/cdk-terraform-state-backend

or

yarn add @pepperize/cdk-terraform-state-backend

Python

pip install pepperize.cdk-terraform-state-backend

C# / .Net

dotnet add package Pepperize.CDK.TerraformStateBackend

Java

<dependency>
  <groupId>com.pepperize</groupId>
  <artifactId>cdk-terraform-state-backend</artifactId>
  <version>${cdkTerraformStateBackend.version}</version>
</dependency>

Example

import { App, Stack } from "@aws-cdk/core";
import { TerraformStateBackend } from "@pepperize/cdk-terraform-state-backend";

const app = new App();
const stack = new Stack(app, "stack", {
  env: {
    account: "123456789012",
    region: "us-east-1",
  },
});

// When
new TerraformStateBackend(stack, "TerraformStateBackend", {
  bucketName: "terraform-state-backend",
  tableName: "terraform-state-backend",
});
terraform {
  backend "s3" {
    bucket = "terraform-state-backend-123456789012-us-east-1"
    dynamodb_table = "terraform-state-backend-123456789012"
    key = "path/to/my/key"
    region = "us-east-1"
  }
}

See Terraform S3 Example Configuration

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

File details

Details for the file pepperize.cdk-terraform-state-backend-0.1.77.tar.gz.

File metadata

File hashes

Hashes for pepperize.cdk-terraform-state-backend-0.1.77.tar.gz
Algorithm Hash digest
SHA256 1a885330e6d042fc2f16c26f3285fcaec8383551aaed8439732c5067b573eadf
MD5 d66d1b40878757dc4d71cbf1efe5e82a
BLAKE2b-256 95f5b13474e93e76fea9ec25b2710e5752e6bf24258a3ce597167d71cb6051eb

See more details on using hashes here.

File details

Details for the file pepperize.cdk_terraform_state_backend-0.1.77-py3-none-any.whl.

File metadata

File hashes

Hashes for pepperize.cdk_terraform_state_backend-0.1.77-py3-none-any.whl
Algorithm Hash digest
SHA256 80b171c1e8f880062d40f0a238523b1dc83c4a31004dc9b91336d015ebfc01ec
MD5 de87a3992d499155cd38cc5ae3b25b71
BLAKE2b-256 70849be7e02ef0009c6ca8ed1ef6e5afc9cff8ae18030b9b166f2a94e7a0fa7e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page