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.61.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5246dad2280b1c6118d61c60ea6bcb55171e07c506d3bdba376eb4efc77b9d74 |
|
MD5 | 194e6b4bbf6e2f3af6e659916ae52af6 |
|
BLAKE2b-256 | 298da0c09910c5c2e8e6ddba9cc78c25d920e5ca34a6c57193befa54881a172f |
Close
Hashes for pepperize.cdk_terraform_state_backend-0.1.61-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5cd64c77a50c41d17dfd3528b859c5f3cdfc48a1358a3b16ee2891aa015a7dd8 |
|
MD5 | b906247cc1fe81ae37e9d9d09bd12fe2 |
|
BLAKE2b-256 | df6909a25e72342e091c4ad92baac901293ce7f7d17bf81d417d86d9f72163d6 |