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.604.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 653e019b0dca94638e7dad9f70ac42ea3e26b0e83251bb646b19ee0be3237447 |
|
MD5 | 9a6d6621542af68ed851749d2d161a64 |
|
BLAKE2b-256 | 7c308299c82569aaff0eca8e13514ce5aa6fb6a31bea6e187ebe4096e9b16ef3 |
Close
Hashes for pepperize.cdk_terraform_state_backend-0.1.604-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b145074a24da4467d816b8f34171968dce4b3b4c2642a5e3241b90e2fc34bd9b |
|
MD5 | 2df423c2d3091b176bb83d7b92fcf012 |
|
BLAKE2b-256 | d5b2610d7036ab146c0892d4dc328e1cc84a0f626089b7e50f9841e1be941784 |