cdktf

What is cdktf?

The cdktf (Cloud Development Kit for Terraform) npm package allows developers to define cloud infrastructure using familiar programming languages instead of HashiCorp Configuration Language (HCL). It provides a way to leverage the power of Terraform with the flexibility and expressiveness of languages like TypeScript, Python, and Java.

What are cdktf's main functionalities?

Defining Infrastructure

This code sample demonstrates how to define an AWS S3 bucket using the cdktf package. It sets up an AWS provider and creates an S3 bucket resource.

const cdktf = require('cdktf');
const { Construct } = require('constructs');
const { App, TerraformStack } = require('cdktf');
const { AwsProvider, S3Bucket } = require('@cdktf/provider-aws');

class MyStack extends TerraformStack {
  constructor(scope, id) {
    super(scope, id);

    new AwsProvider(this, 'Aws', {
      region: 'us-west-2'
    });

    new S3Bucket(this, 'MyBucket', {
      bucket: 'my-cdktf-bucket'
    });
  }
}

const app = new App();
new MyStack(app, 'my-stack');
app.synth();

Synthesizing Terraform Configuration

This code sample shows how to synthesize the Terraform configuration from the defined infrastructure. The `app.synth()` method generates the necessary Terraform JSON configuration files.

const { App } = require('cdktf');
const { MyStack } = require('./my-stack');

const app = new App();
new MyStack(app, 'my-stack');
app.synth();

Using Constructs

This code sample demonstrates how to use constructs to encapsulate and reuse infrastructure definitions. Constructs can be used to create reusable components that can be composed into stacks.

const { Construct } = require('constructs');
const { TerraformStack } = require('cdktf');

class MyConstruct extends Construct {
  constructor(scope, id) {
    super(scope, id);
    // Define resources here
  }
}

class MyStack extends TerraformStack {
  constructor(scope, id) {
    super(scope, id);
    new MyConstruct(this, 'MyConstruct');
  }
}

Other packages similar to cdktf

aws-cdk

The AWS Cloud Development Kit (AWS CDK) is a framework for defining cloud infrastructure in code and provisioning it through AWS CloudFormation. It allows developers to use familiar programming languages to define AWS resources. Compared to cdktf, AWS CDK is specific to AWS and uses CloudFormation as the underlying provisioning engine.

pulumi

Pulumi is an infrastructure as code tool that allows developers to define cloud resources using general-purpose programming languages. It supports multiple cloud providers, including AWS, Azure, and Google Cloud. Pulumi is similar to cdktf in that it allows the use of familiar programming languages, but it does not rely on Terraform as the underlying engine.

serverless

The Serverless Framework is a tool for building and deploying serverless applications. It supports multiple cloud providers and allows developers to define serverless functions and their associated resources. While it focuses on serverless architectures, it provides similar infrastructure as code capabilities as cdktf.

README

cdktf

cdktf is a framework for defining cloud infrastructure using Terraform providers and modules. It allows for users to define infrastructure resources using higher-level programming languages.

Build

Install dependencies

yarn install

Build the package

yarn build