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.123.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | cd082962cc41f406697fae114803fe1d2c8b257af95d113390e8985083038271 |
|
MD5 | 3c0812eaf1c504387d78a0c0b1af15f5 |
|
BLAKE2b-256 | 308c5fb6bc3637a24212b1ea4639ca2e6aea33789abac1aaea5c94129ddc2b50 |
Close
Hashes for pepperize.cdk_terraform_state_backend-0.0.123-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c04aafb344360f827b1ddb80b81aff9379b95626dff21a943c3aeaac764dda7a |
|
MD5 | 0ca0f85fda47a45167ca798c9c23ab90 |
|
BLAKE2b-256 | 6cc872605b5361317c1c9abf2fc32ac3d27b11f96386cebe41eba8099226abae |