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 } from "cdktf-tf-module-stack";
import { NullProvider, Resource } from "@cdktf/provider-null";

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

    new NullProvider(this, "null");
    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.0.33.tar.gz (21.6 kB view details)

Uploaded Source

Built Distribution

cdktf_tf_module_stack-0.0.33-py3-none-any.whl (21.2 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for cdktf-tf-module-stack-0.0.33.tar.gz
Algorithm Hash digest
SHA256 7d7f60c6145e29b21cb9093513086e4dfb5acfde21e38460e8ec42bc4f548c14
MD5 8abf70a7dc81659eb7d41c3e3a0254f1
BLAKE2b-256 f9850b6fb40fa76f842d667d6141ea838e452c004f075c6c4530f038c0255ecd

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cdktf_tf_module_stack-0.0.33-py3-none-any.whl
Algorithm Hash digest
SHA256 ffe35441bd3d78014ac235be9afd7d86fd00e894a5e20b4e3ebc8861217ea08c
MD5 16e0b67df6d148c4f7a4464b029180dc
BLAKE2b-256 88b860be907962e1a7377e9413dc7d5c18073221d67c55c8edef47c97bb55d40

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