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.780.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | d3f4368cca2868b8b04db7b46557c6754a24fdbc5cbb07ee30fe4b870cfbf13a |
|
MD5 | b313e0723ed9235e2275c42460ab93d7 |
|
BLAKE2b-256 | ca97d8a45ebfe9db8727a706b33de9b1aef40ae7eca0c028d162343625c2dd03 |
Close
Hashes for pepperize.cdk_terraform_state_backend-0.1.780-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1c71ccee7cb0c6cae1826a9c5afd45bcbefc06897559a5be96aa353587013f61 |
|
MD5 | f9e9d5647ff4be8c7441cb71f1a147e3 |
|
BLAKE2b-256 | c6da707425bde50538428e167ce55aef71a70dfdf433fb46d628d4fce210aad6 |