Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ description: CDKTF Core API Reference for Classes in CSharp.

# CSharp: Classes <a name="Classes" id="Classes"></a>

@include 'deprecated.mdx'

### Annotations <a name="Annotations" id="cdktf.Annotations"></a>

Includes API for attaching annotations such as warning messages to constructs.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ description: CDKTF Core API Reference for Constructs in CSharp.

# CSharp: Constructs <a name="Constructs" id="Constructs"></a>

@include 'deprecated.mdx'

### App <a name="App" id="cdktf.App"></a>

Represents a cdktf application.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ description: CDKTF Core API Reference for Enums in CSharp.

# CSharp: Enums <a name="Enums" id="Enums"></a>

@include 'deprecated.mdx'

### AnnotationMetadataEntryType <a name="AnnotationMetadataEntryType" id="cdktf.AnnotationMetadataEntryType"></a>

#### Members <a name="Members" id="Members"></a>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ description: Learn about the API resources available in the Terraform CDK librar

# C# API resource reference overview

@include 'deprecated.mdx'

The C# API reference includes the following resources:

- [Classes](/terraform/cdktf/api-reference/csharp/classes)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ description: CDKTF Core API Reference for Protocols in CSharp.

# CSharp: Protocols <a name="Protocols" id="Protocols"></a>

@include 'deprecated.mdx'

### IAnyProducer <a name="IAnyProducer" id="cdktf.IAnyProducer"></a>

- _Implemented By:_ <a href="#cdktf.IAnyProducer">IAnyProducer</a>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ description: CDKTF Core API Reference for Structs in CSharp.

# CSharp: Structs <a name="Structs" id="Structs"></a>

@include 'deprecated.mdx'

### AppConfig <a name="AppConfig" id="cdktf.AppConfig"></a>

#### Initializer <a name="Initializer" id="cdktf.AppConfig.Initializer"></a>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ description: CDKTF Core API Reference for Classes in Go.

# Go: Classes <a name="Classes" id="Classes"></a>

@include 'deprecated.mdx'

### Annotations <a name="Annotations" id="cdktf.Annotations"></a>

Includes API for attaching annotations such as warning messages to constructs.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ description: CDKTF Core API Reference for Constructs in Go.

# Go: Constructs <a name="Constructs" id="Constructs"></a>

@include 'deprecated.mdx'

### App <a name="App" id="cdktf.App"></a>

Represents a cdktf application.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ description: CDKTF Core API Reference for Enums in Go.

# Go: Enums <a name="Enums" id="Enums"></a>

@include 'deprecated.mdx'

### AnnotationMetadataEntryType <a name="AnnotationMetadataEntryType" id="cdktf.AnnotationMetadataEntryType"></a>

#### Members <a name="Members" id="Members"></a>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ description: Learn about the API resources available in the Terraform CDK librar

# Go API resource reference overview

@include 'deprecated.mdx'

The Go API reference includes the following resources:

- [Classes](/terraform/cdktf/api-reference/go/classes)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ description: CDKTF Core API Reference for Protocols in Go.

# Go: Protocols <a name="Protocols" id="Protocols"></a>

@include 'deprecated.mdx'

### IAnyProducer <a name="IAnyProducer" id="cdktf.IAnyProducer"></a>

- _Implemented By:_ <a href="#cdktf.IAnyProducer">IAnyProducer</a>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ description: CDKTF Core API Reference for Structs in Go.

# Go: Structs <a name="Structs" id="Structs"></a>

@include 'deprecated.mdx'

### AppConfig <a name="AppConfig" id="cdktf.AppConfig"></a>

#### Initializer <a name="Initializer" id="cdktf.AppConfig.Initializer"></a>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ description: >-

# Core Library API Reference

@include 'deprecated.mdx'

The CDK for Terraform (CDKTF) core library lets you define infrastructure resources using familiar programming languages. CDKTF translates the API into the following supported languages.

- [Typescript](/terraform/cdktf/api-reference/typescript)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ description: CDKTF Core API Reference for Classes in Java.

# Java: Classes <a name="Classes" id="Classes"></a>

@include 'deprecated.mdx'

### Annotations <a name="Annotations" id="cdktf.Annotations"></a>

Includes API for attaching annotations such as warning messages to constructs.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ description: CDKTF Core API Reference for Constructs in Java.

# Java: Constructs <a name="Constructs" id="Constructs"></a>

@include 'deprecated.mdx'

### App <a name="App" id="cdktf.App"></a>

Represents a cdktf application.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ description: CDKTF Core API Reference for Enums in Java.

# Java: Enums <a name="Enums" id="Enums"></a>

@include 'deprecated.mdx'

### AnnotationMetadataEntryType <a name="AnnotationMetadataEntryType" id="cdktf.AnnotationMetadataEntryType"></a>

#### Members <a name="Members" id="Members"></a>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ description: Learn about the API resources available in the Terraform CDK librar

# Java API resource reference overview

@include 'deprecated.mdx'

The Java API reference includes the following resources:

- [Classes](/terraform/cdktf/api-reference/java/classes)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ description: CDKTF Core API Reference for Protocols in Java.

# Java: Protocols <a name="Protocols" id="Protocols"></a>

@include 'deprecated.mdx'

### IAnyProducer <a name="IAnyProducer" id="cdktf.IAnyProducer"></a>

- _Implemented By:_ <a href="#cdktf.IAnyProducer">IAnyProducer</a>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ description: CDKTF Core API Reference for Structs in Java.

# Java: Structs <a name="Structs" id="Structs"></a>

@include 'deprecated.mdx'

### AppConfig <a name="AppConfig" id="cdktf.AppConfig"></a>

#### Initializer <a name="Initializer" id="cdktf.AppConfig.Initializer"></a>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ description: >-

# Provider API Reference

@include 'deprecated.mdx'

A provider is a Terraform plugin that allows users to manage an external API. You can use CDK for Terraform (CDKTF) with every provider available on the [Terraform Registry](https://registry.terraform.io/browse/providers). Refer to [Providers](/terraform/cdktf/concepts/providers) for details about how to import and use providers in your CDKTF application.

We offer several popular providers as pre-built packages to help reduce the time required to generate provider code bindings for your CDKTF application. These pre-build providers are available in the CDKTF [GitHub namespace](https://github.com/topics/pre-built-provider).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ description: CDKTF Core API Reference for Classes in Python.

# Python: Classes <a name="Classes" id="Classes"></a>

@include 'deprecated.mdx'

### Annotations <a name="Annotations" id="cdktf.Annotations"></a>

Includes API for attaching annotations such as warning messages to constructs.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ description: CDKTF Core API Reference for Constructs in Python.

# Python: Constructs <a name="Constructs" id="Constructs"></a>

@include 'deprecated.mdx'

### App <a name="App" id="cdktf.App"></a>

Represents a cdktf application.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ description: CDKTF Core API Reference for Enums in Python.

# Python: Enums <a name="Enums" id="Enums"></a>

@include 'deprecated.mdx'

### AnnotationMetadataEntryType <a name="AnnotationMetadataEntryType" id="cdktf.AnnotationMetadataEntryType"></a>

#### Members <a name="Members" id="Members"></a>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ description: Learn about the API resources available in the Terraform CDK librar

# Python API resource reference overview

@include 'deprecated.mdx'

The Python API reference includes the following resources:

- [Classes](/terraform/cdktf/api-reference/python/classes)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ description: CDKTF Core API Reference for Protocols in Python.

# Python: Protocols <a name="Protocols" id="Protocols"></a>

@include 'deprecated.mdx'

### IAnyProducer <a name="IAnyProducer" id="cdktf.IAnyProducer"></a>

- _Implemented By:_ <a href="#cdktf.IAnyProducer">IAnyProducer</a>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ description: CDKTF Core API Reference for Structs in Python.

# Python: Structs <a name="Structs" id="Structs"></a>

@include 'deprecated.mdx'

### AppConfig <a name="AppConfig" id="cdktf.AppConfig"></a>

#### Initializer <a name="Initializer" id="cdktf.AppConfig.Initializer"></a>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ description: CDKTF Core API Reference for Classes in Typescript.

# Typescript: Classes <a name="Classes" id="Classes"></a>

@include 'deprecated.mdx'

### Annotations <a name="Annotations" id="cdktf.Annotations"></a>

Includes API for attaching annotations such as warning messages to constructs.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ description: CDKTF Core API Reference for Constructs in Typescript.

# Typescript: Constructs <a name="Constructs" id="Constructs"></a>

@include 'deprecated.mdx'

### App <a name="App" id="cdktf.App"></a>

Represents a cdktf application.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ description: CDKTF Core API Reference for Enums in Typescript.

# Typescript: Enums <a name="Enums" id="Enums"></a>

@include 'deprecated.mdx'

### AnnotationMetadataEntryType <a name="AnnotationMetadataEntryType" id="cdktf.AnnotationMetadataEntryType"></a>

#### Members <a name="Members" id="Members"></a>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ description: Learn about the API resources available in the Terraform CDK librar

# Typescript API resource reference overview

@include 'deprecated.mdx'

The Typescript API reference includes the following resources:

- [Classes](/terraform/cdktf/api-reference/typescript/classes)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ description: CDKTF Core API Reference for Protocols in Typescript.

# Typescript: Protocols <a name="Protocols" id="Protocols"></a>

@include 'deprecated.mdx'

### IAnyProducer <a name="IAnyProducer" id="cdktf.IAnyProducer"></a>

- _Implemented By:_ <a href="#cdktf.IAnyProducer">IAnyProducer</a>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ description: CDKTF Core API Reference for Structs in Typescript.

# Typescript: Structs <a name="Structs" id="Structs"></a>

@include 'deprecated.mdx'

### AppConfig <a name="AppConfig" id="cdktf.AppConfig"></a>

#### Initializer <a name="Initializer" id="cdktf.AppConfig.Initializer"></a>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ description: Install and configure the CDKTF Command Line Interface.

# CLI Configuration

@include 'deprecated.mdx'

The CDK for Terraform (CDKTF) CLI allows you to initialize a new CDKTF project, adjust project settings, synthesize your infrastructure into Terraform configuration files, deploy your CDKTF application, and more. You can also use some Terraform CLI commands like `terraform apply` and `terraform destroy` directly, but we recommend using the available [`cdktf cli` commands](/terraform/cdktf/cli-reference/commands) where possible.

## Install
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ description: >-

# CLI Commands

@include 'deprecated.mdx'

The CDK for Terraform CLI has the following commands:

- [completion](/terraform/cdktf/cli-reference/commands#completion)
Expand Down
2 changes: 1 addition & 1 deletion content/terraform-cdk/v0.21.x/docs/cdktf/community.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: >-

# Community

CDK for Terraform (CDKTF) is under active development, and we would love your feedback and direct contributions to help guide the project.
@include 'deprecated.mdx'

## Questions & Issues

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ description: >-

# Aspects

@include 'deprecated.mdx'

Aspects allow you to apply an operation to all constructs within a given scope. You may want to use them in your CDK for Terraform (CDKTF) application to mutate elements (e.g., add tags to cloud resources) or for validation (e.g., ensure all S3 Buckets are encrypted).

## Define Aspects
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ description: >-

# Assets

@include 'deprecated.mdx'

In CDK for Terraform (CDKTF) v0.4+, asset constructs can manage assets for resources that need them, such as template_file, S3 bucket objects, or Lambda function archive files. You can use Terraform assets to move existing files or directories into your CDKTF application so that you can use them in resource definitions.

Assets are especially useful for:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ description: Key CDK for Terraform components and application structure.

# Architecture

@include 'deprecated.mdx'

This page explains the tools and processes that CDK for Terraform (CDKTF) uses to leverage the Terraform ecosystem and convert code into Terraform configuration files. It also explains the major components of a CDKTF application and how those pieces fit together.

## CDKTF Building Blocks
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ description: >-

# Constructs

@include 'deprecated.mdx'

## What is a construct?

In CDKTF, a construct is a building block that can represent anything from a single resource to a complex subset of your infrastructure. Each CDKTF program can be thought of as a tree being made up of constructs.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ description: >-

# Data Sources

@include 'deprecated.mdx'

[Terraform data sources](/terraform/language/data-sources) fetch information from external APIs and from other Terraform configurations. For example, you may want to import disk image IDs from a cloud provider or share data between configurations for different parts of your infrastructure.

## When to Use Data Sources
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ description: Learn when to use built-in Terraform functions to transform or comb

# Functions

@include 'deprecated.mdx'

Terraform provides a set of built-in functions that transform and combine values within Terraform configurations. The [Terraform function documentation](/terraform/language/functions) contains a complete list. You can also use your editor autocompletion on the `Fn` object to find available options.

Functions can handle normal and [token](/terraform/cdktf/concepts/tokens) values and will return either tokenized values or `IResolvable` values.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ description: >-

# HCL Interoperability

@include 'deprecated.mdx'

Terraform requires infrastructure configuration files written in either [HashiCorp Configuration Language (HCL)](/terraform/language/syntax/configuration) or JSON syntax. CDK for Terraform (CDKTF) works by translating configurations defined in an imperative programming language to JSON configuration files for Terraform.
Starting from version 0.20, CDKTF can also generate Terraform HCL as output by setting the `--hcl` flag when running `cdktf synth`.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ description: >-

# Iterators

@include 'deprecated.mdx'

Iterators let you loop over a collection of values. You can use them to create multiple resources of the same type based on dynamic data that is only known at runtime.

## When to Use Iterators
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ description: >-

# Modules

@include 'deprecated.mdx'

A [Terraform module](/terraform/language/modules) is a single directory that contains one or more configuration files.

Modules let you reuse configurations across projects and teams, saving time, enforcing consistency, and reducing errors. For example, you could create a module to describe the configuration for all of your organization's public website buckets. When you package and share this module, other users can incorporate it into their configurations. As requirements evolve, you can make changes to your module once, release a new version, and apply those changes everywhere that module is used.
Expand Down
Loading
Loading