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
- IAM Policy with read/write access to the created S3 Bucket and DynamoDB Table
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.1.64.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | fe54f307a1bbe0ba297cde0f2e876b0f6f601ce3443cfcf243aa2ec44edbe7bd |
|
MD5 | aabda2162793684f8d64cb8979b1d6b7 |
|
BLAKE2b-256 | a5589a389241412b69b93b625bce2393d0500ac6ce1cf167d6829d5afb92f9e3 |
Close
Hashes for pepperize.cdk_terraform_state_backend-0.1.64-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 283a9a4bdb9e656fe586aaf490c93074100424aae46f4a2641516d3a97a4c424 |
|
MD5 | a04de3027eb227c58416d36af159f7a3 |
|
BLAKE2b-256 | c4aa635a93fccccd27bee3b69b7379a1e71a8ca12853c40e4753c391e26eff3a |