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.498.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8c6efef9491a7b91eacd8fa33eddea17fde468cc5def30669d1d0989b8ab2ff9 |
|
MD5 | 6ba828b083b327578327731c8ed7c7b2 |
|
BLAKE2b-256 | a87b21995c8f9cdb0320a2e0dcf103c933268f9c4a8c835214dbd456f2b03e50 |
Close
Hashes for pepperize.cdk_terraform_state_backend-0.1.498-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2bb99770998ca549a4ebc027f4dea93afc5b7d1e0d5bdf154a2cf5a40622ef61 |
|
MD5 | e024f7c3ab934a37b85a44eeefb61eec |
|
BLAKE2b-256 | bedc811f4bf870b67ad6d1ebb7d3313a4b0fc61287f86086235429225982f9d2 |