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.114.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 09a3c28f0a41bf7c26961f499b59cb7bdb44477d37760ab0dc3e749d317da831 |
|
MD5 | 0922c6cc0aa7da0f27e7930d3f140c75 |
|
BLAKE2b-256 | 31bb469c096db7d955de672635b7c935f306d75df3ef81a1f4a58dab85ab06e4 |
Close
Hashes for pepperize.cdk_terraform_state_backend-0.0.114-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e464f70773a632deeda46f27a9d978a36dc43e8f4edcc19f38c18534f79c2d38 |
|
MD5 | f69270d225b6ab1fd2949791c7f5dc14 |
|
BLAKE2b-256 | 3693a462543d24613be145591f25cbf2f937a3ab747dea52548a52b1ec71f90a |