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
Java
<dependency>
<groupId>com.pepperize</groupId>
<artifactId>cdk-terraform-state-backend</artifactId>
<version>${cdkTerraformStateBackend.version}</version>
</dependency>
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.142.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f862514f82cc431993cfd3849c24b4f7f90887d28f269f089508afc24d8d3bd1 |
|
MD5 | db65d5e7295d9d026391bacdcc800c34 |
|
BLAKE2b-256 | 0313d189fd5a87f19783078a87ecc90d382f9fef4997e271ba282c2ccb236b1d |
Close
Hashes for pepperize.cdk_terraform_state_backend-0.1.142-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 356dbfefa40f9b52d9e50e0d7cb1fabf2e95f15cc40d3cc96c345e3484264a24 |
|
MD5 | 178f1270291d0389d8fb4915bafa3465 |
|
BLAKE2b-256 | 56be028bc7b481486dd5e441f8469e465c13711271d820e6b1cc0c9ae2bef63e |