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.82.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2bdf868b8160a4f10790bb15e13e0a8804e824cf926b88ab39b1b335d5a1ddd4 |
|
MD5 | 2708726902127587b40e33ea815377b2 |
|
BLAKE2b-256 | 80d305ca682eeed44ec65c63497d8c2da09a9bc02047447d7b7c45778941c18d |
Close
Hashes for pepperize.cdk_terraform_state_backend-0.0.82-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6b675313763aad9675dc997c4d8d6e83cd7bf4648c5bc339467b8bf6f544a3e2 |
|
MD5 | 0d49cd7b84e7f04ed6386e6e7b8c2f35 |
|
BLAKE2b-256 | c9629262e3f95475a11a6e308f1a2c9683f2e7dd2b0867eeed10616f4a25eee2 |