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.835.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | fcac0286798eb569d6993838ecc938fe67091489e9b7492db6b4a4854ff54559 |
|
MD5 | 32dc38cade78ac660a4c4020bc678eb3 |
|
BLAKE2b-256 | 43bffc635d9c40af501afa4516cc49c4add44b4316959b7c5915e8cdc86f6545 |
Close
Hashes for pepperize.cdk_terraform_state_backend-0.1.835-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a88aa9e76ca153f5eba8bcbc1b9e519d63ad92b32bdd2eef0fdcb8e7ec9f2e96 |
|
MD5 | bcad9f6ae974aea32bf9c83d29fcc379 |
|
BLAKE2b-256 | d5f4d989ed2bde8febb7747014fffb69f06a76cb8c1dfeb9f908565490d4e45d |