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.87.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | e4583c343cb0441a377a04e40ba8e3abf9bd63c3f7b1506199a5245a3f349a01 |
|
MD5 | b91b34ebce99d3c9991d43f472128ba4 |
|
BLAKE2b-256 | 22e18fd95f163f63b3ac4e55c1ba569b31076a783559b497fa7cd42fc5d2b4ae |
Close
Hashes for pepperize.cdk_terraform_state_backend-0.1.87-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | eb17b6e3fc80599c2ea6eb0a2e86eaa26387bc29294ec894c84a556e5a3c9b10 |
|
MD5 | e6f71c643a049e2f9ad055e206c12893 |
|
BLAKE2b-256 | 1cf5f1239505519069903beeb78af2e8d1d9ea61f48bcd664e1b97fef802936e |