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.121.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | efe4ceec8ad7c0c1ad6c3b8053068a73a209b1ee4500cecddcde373d2b2ac83e |
|
MD5 | 120a7532ebb058d1935fb65746811422 |
|
BLAKE2b-256 | e5abfbe85ddb37034fcdb31f36a52e171ed85f734c954bca083c21cec9344a0c |
Close
Hashes for pepperize.cdk_terraform_state_backend-0.0.121-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1325e7d6fe16c452b0cf679c396ca6defda4d032dad2119086299eed9281899c |
|
MD5 | 52bdd2326db376aaf3c4c854b5ee949c |
|
BLAKE2b-256 | aa0106cbed0a79fa81180243cb9eeb7afb8f994cf2117f74e2671d783c1f8c5c |