This project provides a CDK construct bootstrapping an AWS account with a S3 Bucket and a DynamoDB table as terraform state backend.
Project description
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"
}
}
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
Close
Hashes for pepperize.cdk-terraform-state-backend-0.1.680.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | bf4aeb30309ab0f26308b35704a2f6009958ab1daebe664bb8e0c0ae401b78b9 |
|
MD5 | d5ddd556bea72d72f16cb607d41cf43e |
|
BLAKE2b-256 | bf7e0dffdf39f860743722ff2d93940de5f3bdb4d93a000f71544624edd05290 |
Close
Hashes for pepperize.cdk_terraform_state_backend-0.1.680-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 581223ab96b2b6d4aba1fcebeaf3e5eb347b633ecded4407efb199811aca49ff |
|
MD5 | 41908c31adfd388d1806b788fa570087 |
|
BLAKE2b-256 | 7c2b6d8114b59492220de315cde2fcc5542b1c4d6b17b37aeaf06f984831ac12 |