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.183.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 56fcc5a38e53f293064804a8a9c714822b44ad96e405f54c60c9a29644a5cb80 |
|
MD5 | 66dbc299c3a9499ff24104614390dbab |
|
BLAKE2b-256 | cd9a906da9dbb3a6c167abc99b01f138f832eba57c0de6bc677768427321e79d |
Close
Hashes for pepperize.cdk_terraform_state_backend-0.0.183-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 80dcd3d92a373b910fb745a94c732a23a4fc92f00caf44bfc96e81d43de8d8d8 |
|
MD5 | 3d5eb707540be814171d9e767643bf47 |
|
BLAKE2b-256 | 7077c601443084a4adefa25f919556415deeabb570a7013a748a0cc5077d98bb |