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.120.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 99a7fc64deda2979b1ee1cbfdd347af4369326a7ff95c58b4c018196137fd2be |
|
MD5 | ad7c465a7b96a32202bf14c194132f51 |
|
BLAKE2b-256 | 407a231aec9419cf19c5f561b6073207a79d478332b8df7f51845365812bf795 |
Close
Hashes for pepperize.cdk_terraform_state_backend-0.0.120-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2e1da5b92aec8a4a736282067d562b51eb98377fc9112d30d4628d3cd1f0ff2d |
|
MD5 | a65f31698afdd60e285f69644a6e8a4f |
|
BLAKE2b-256 | 0d24c4686ed34464d2a0ed6c273af1dae601b4ce1e8c70235ebb8791ac35594a |