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.177.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 12959d85c5a7b925463734d537550457f638f860dff7f6b596565994584bc848 |
|
MD5 | a007cf7cabbec586f98b7920fb9e6883 |
|
BLAKE2b-256 | ae3c49ffbcdef201536d90fa4f6b536929ba7a2cff56482380a0209592f4a964 |
Close
Hashes for pepperize.cdk_terraform_state_backend-0.0.177-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | fcfb8ea253e18f490c1e02489167ba563a58a73b5fd71cdc17c9f372a3e5e33b |
|
MD5 | b9258de37e420a0bbd5439ef9b73cd43 |
|
BLAKE2b-256 | df943d8db1a4a0ea8ef34445e273abd77dadf299071a2c6ebb8a6263d1e3cd4a |