Skip to main content

A drop-in replacement for cdktf.TerraformStack that lets you define Terraform modules as constructs

Project description

cdktf-tf-module-stack

Status: Tech Preview Releases LICENSE build

A drop-in replacement for cdktf.TerraformStack that lets you define Terraform modules as constructs.

cdktf-tf-module-stack is in technical preview, which means it's a community supported project. It still requires extensive testing and polishing to mature into a HashiCorp officially supported project. Please file issues generously and detail your experience while using the library. We welcome your feedback.

By using the software in this repository, you acknowledge that:

  • cdktf-tf-module-stack is still in development, may change, and has not been released as a commercial product by HashiCorp and is not currently supported in any way by HashiCorp.
  • cdktf-tf-module-stack is provided on an "as-is" basis, and may include bugs, errors, or other issues.
  • cdktf-tf-module-stack is NOT INTENDED FOR PRODUCTION USE, use of the Software may result in unexpected results, loss of data, or other unexpected results, and HashiCorp disclaims any and all liability resulting from use of cdktf-tf-module-stack.
  • HashiCorp reserves all rights to make all decisions about the features, functionality and commercial release (or non-release) of cdktf-tf-module-stack, at any time and without any obligation or liability whatsoever.

Compatibility

  • cdktf >= 0.19.0
  • constructs >= 10.0.25

Available Packages

NPM

The npm package is available at https://www.npmjs.com/package/@cdktf/tf-module-stack.

npm install @cdktf/tf-module-stack

NOTE: Originally, this package was named cdktf-tf-module-stack, and the legacy versions (<= 0.2.0) can be found on npm here.

PyPI

The PyPI package is available at https://pypi.org/project/cdktf-tf-module-stack.

pipenv install cdktf-tf-module-stack

Nuget

The Nuget package is available at https://www.nuget.org/packages/HashiCorp.Cdktf.TfModuleStack.

dotnet add package HashiCorp.Cdktf.TfModuleStack

Maven

The Maven package is available at https://mvnrepository.com/artifact/com.hashicorp/cdktf-tf-module-stack.

<dependency>
    <groupId>com.hashicorp</groupId>
    <artifactId>cdktf-tf-module-stack</artifactId>
    <version>[REPLACE WITH DESIRED VERSION]</version>
</dependency>

Go

The go package is generated into the github.com/cdktf/cdktf-tf-module-stack-go package.

go get github.com/cdktf/cdktf-tf-module-stack-go/tfmodulestack

Usage

Typescript

import { App } from "cdktf";
import {
  TFModuleStack,
  TFModuleVariable,
  TFModuleOutput,
  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");
    const resource = new Resource(this, "resource");

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

    new TFModuleOutput(this, "my_output", {
      value: resource.id,
    });
  }
}

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

Python

from constructs import Construct
from cdktf import App, TerraformStack
from imports.null.resource import Resource
from cdktf_tf_module_stack import TFModuleStack, TFModuleVariable, TFModuleOutput, ProviderRequirement


class MyAwesomeModule(TFModuleStack):
    def __init__(self, scope: Construct, ns: str):
        super().__init__(scope, ns)

        ProviderRequirement(self, "null", provider_version_constraint="~> 2.0")

        TFModuleVariable(self, "my_var", type="string", description="A variable", default="default")

        resource = Resource(self, "resource")

        TFModuleOutput(self, "my_output", value=resource.id)


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

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

{
  "output": {
    "my_output": [
      {
        "value": "${null_resource.resource.id}"
      }
    ]
  },
  "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

This version

4.0.7

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-4.0.7.tar.gz (54.4 kB view details)

Uploaded Source

Built Distribution

cdktf_tf_module_stack-4.0.7-py3-none-any.whl (52.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: cdktf-tf-module-stack-4.0.7.tar.gz
  • Upload date:
  • Size: 54.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.12.0

File hashes

Hashes for cdktf-tf-module-stack-4.0.7.tar.gz
Algorithm Hash digest
SHA256 9e6800cc832fe1ceb26c646ed156b68787cf525ca6978d490370dccf4166b307
MD5 8f5923734c14b6eaaab2f4fa8b54f9b4
BLAKE2b-256 0670c22589a704492d24016960542e4b437891e7a42dd781e4374c82dd846319

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cdktf_tf_module_stack-4.0.7-py3-none-any.whl
Algorithm Hash digest
SHA256 ada520a06b79d0fc1da472555ad5670ed7c37a4031f63d08577d82714972d286
MD5 c7675cba3c3a0df160c0d6701adb05b6
BLAKE2b-256 09923c6d84c085340dbb3e9ff120e6fd4d67649a442227f5df2e35d8de88b261

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