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.176.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9108703bfe2469e5d1aed276828584dab39c50e4f2dd9996c621746ae06869da |
|
MD5 | 92bc742d99b441cc78841bf7ec17d8df |
|
BLAKE2b-256 | c679808cd12ce7e4815ad8d3f140302c767cd308ea0d36b6df073226f7636d7b |
Close
Hashes for pepperize.cdk_terraform_state_backend-0.0.176-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | bda9c984c3a7a02d518d0600cd065ca9c2d62de98f7564d99cc49006b2bd0e7c |
|
MD5 | 172bb3c2bae7a01d43a58cab537194cd |
|
BLAKE2b-256 | 266271f28a6dace5e5f888e8170c0ee2443df41fd55b6ab18fe38ad75d6bf426 |