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
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
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.0.90.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 166894a209b9e0d8db53008a015118587fffdb026bd248b0f8079cf72cc61dbe |
|
MD5 | 24770e9e9feb763967b5ddfed5c7a32a |
|
BLAKE2b-256 | 469e1dc4df50d12620e87c51f2c87a15d5c2972756ec691be18cfa15aac076e8 |
Close
Hashes for pepperize.cdk_terraform_state_backend-0.0.90-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b7201af56a121bf4f57745002c3fb07de6d362fca89b9da3aad2f97704b0aac5 |
|
MD5 | dbb54c18ebb6badc7215e12a9af7696e |
|
BLAKE2b-256 | 276f51616f4a37da175ba2a857d8cdc69cccf27f3ee4277e6605bc0466cda8fa |