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.277.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 90f795259172b5dc37f48026f6f2626434ca9f3ee498a1bc127229cc741040a8 |
|
MD5 | acf4e7f9855afccd379d5d61791a7eb6 |
|
BLAKE2b-256 | 499618804d7e1f95b41443ffffa67294d1cb6d4adad29c75683e4450cd06ec80 |
Close
Hashes for pepperize.cdk_terraform_state_backend-0.1.277-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b579e39dcfb4ef423534da08372dd4956e5d750c9eee5291abe4062a3074d959 |
|
MD5 | 45cf12f4247a93649570684e685c334c |
|
BLAKE2b-256 | d813f8cb121a7347d6b4d5ce4f2bcae3a32e41b55e4bb979fa139d79311629ea |