Skip to main content

A drop-in replacement for cdktf.TerraformStack that let's you define Terraform modules as construct

Project description

cdktf-tf-module-stack

A drop-in replacement for cdktf.TerraformStack that let's you define Terraform modules as construct.

Setup

Node.js

Run yarn add cdktf-tf-module-stack (or npm install --save cdktf-tf-module-stack) to install the package.

Python

Run pip install cdktf-tf-module-stack to install the package.

Usage

import { App } from "cdktf";
import {
  TFModuleStack,
  TFModuleVariable,
  ProviderRequirement,
} from "cdktf-tf-module-stack";
import { Resource } from "@cdktf/provider-null";

class MyAwesomeModule extends TFModuleStack {
  constructor(scope: Construct, id: string) {
    super(scope, id);

    new ProviderRequirement(this, "null", "~> 2.0");
    new Resource(this, "resource");

    new TFModuleVariable(this, "my_var", {
      type: "string",
      description: "A variable",
      default: "default",
    });
  }
}

const app = new App();
new MyAwesomeModule(app, "my-awesome-module");
app.synth();

This will synthesize a Terraform JSON file that looks like this:

{
  "resource": {
    "null_resource": {
      "resource": {}
    }
  },
  "terraform": {
    "required_providers": {
      "null": {
        "source": "null",
        "version": "~> 2.0"
      }
    },
    "variable": {
      "my_var": {
        "default": "default",
        "description": "A variable",
        "type": "string"
      }
    }
  }
}

Please note that the provider section is missing, so that the Terraform Workspace using the generated module can be used with any provider matching the version.

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

cdktf-tf-module-stack-0.1.17.tar.gz (25.7 kB view details)

Uploaded Source

Built Distribution

cdktf_tf_module_stack-0.1.17-py3-none-any.whl (24.4 kB view details)

Uploaded Python 3

File details

Details for the file cdktf-tf-module-stack-0.1.17.tar.gz.

File metadata

File hashes

Hashes for cdktf-tf-module-stack-0.1.17.tar.gz
Algorithm Hash digest
SHA256 3a404c09d029dd3e764108134161c46078ccb9e4a21556612f30b3fb660bbceb
MD5 c35265d0f9425c4ef8818f43c2f6ac2e
BLAKE2b-256 2a20cd61e8c3caedd7a3aa9653c7faec1138124179166f4a4f4017a1bb4e00b3

See more details on using hashes here.

File details

Details for the file cdktf_tf_module_stack-0.1.17-py3-none-any.whl.

File metadata

File hashes

Hashes for cdktf_tf_module_stack-0.1.17-py3-none-any.whl
Algorithm Hash digest
SHA256 ea279d6b5cdbf9a747d20e66e9d6bd5a9b445a733cbbebf26a4ef032ffc45e1d
MD5 5607e336bda306b88ce3a86502310d70
BLAKE2b-256 5668236a5883a0fcf4129f2d872ced7ec7b37c434ae4d97c48e141c723237d7f

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page