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.600.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | bfb8650a2581d2f2c33307ecee43606c84aa22a27d33ef21733f6bd255ef35ba |
|
MD5 | bbb2e6203c80c6bcd46cb2dd3aff6fa3 |
|
BLAKE2b-256 | 4f3c831d4bc942884423527f8c84b3a8b9b1995c6251b7bfa47f5532bc39e3ae |
Close
Hashes for pepperize.cdk_terraform_state_backend-0.1.600-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 62818c5aaa893bf60da575bd60c6f488bc89167f929b40055d6e29361cbd25ff |
|
MD5 | 114f79042a220c4eda57acfbf52c0410 |
|
BLAKE2b-256 | 5f561bc5b0dc05b8bbe7f366cfa6ba86e22d236834499d749c17fd312f2bb572 |