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.590.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ad2e386c765563e9331dd055bfcb0b8dbfe99ba0409cdc7ac9169056e53ddc8c |
|
MD5 | 24ee06d1864b012142f994da046c64a6 |
|
BLAKE2b-256 | 6977b0f7887c80e2b5683194731fe2e4d54b605a78dd0e5fd63dcd3a7f04ffee |
Close
Hashes for pepperize.cdk_terraform_state_backend-0.1.590-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3492ddd4ae3815514409ea4e5c579a340c73f8edfdde7543835fb32b89217201 |
|
MD5 | b27ec25d71d433bb079d2f76a5e1894c |
|
BLAKE2b-256 | 3eb042f6ebfa76c5468f4c64694b50a90e848968dada28c93fb95f30ad719b0d |