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.142.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 47272c242b913dd0387c1c9141f41f10f1534fc9700a4eb8506d534d30f7e18b |
|
MD5 | ec021dbcdf39076c8be7ea8771ebd06c |
|
BLAKE2b-256 | 370f27ca5e78a9481ee793ffee669e0cc40f0d4cabd9958ecd81176646348404 |
Close
Hashes for pepperize.cdk_terraform_state_backend-0.0.142-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | bd3409f07051abc9753c1567029a705b9482a1278de5bb3277d7a0cafc7131e6 |
|
MD5 | 897307e027a0a4172e3049f781892f4c |
|
BLAKE2b-256 | dbc26782a3c1de255984ccd177b07a3dc89c2a7add5471c572bf5e8c69817774 |