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.122.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 789f11596271414957b5c9c1ad03512232836828999b6dbb4613b738da2f3cfd |
|
MD5 | d23c0772cb5fb471e916d1d795ac8fb9 |
|
BLAKE2b-256 | 511fcf54e5dfe3e73b7b93d94a5dc6a31fee879ab49fc1f0487eca2b957d2cb9 |
Close
Hashes for pepperize.cdk_terraform_state_backend-0.0.122-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8e2ad0fc4d22790ce8212d94ccd137afff5b6fd50c7e087b8080076eaf857865 |
|
MD5 | cbe5b3542be7d81a9161ec278121685a |
|
BLAKE2b-256 | 501f0eda87293b2f22522c32f8a3371ca7906fa42b9ffb554c91cee5cca4e4d1 |