diff --git a/content/terraform-cdk/v0.18.x/docs/partials/deprecated.mdx b/content/terraform-cdk/v0.18.x/docs/partials/deprecated.mdx new file mode 100644 index 0000000000..d61a331b46 --- /dev/null +++ b/content/terraform-cdk/v0.18.x/docs/partials/deprecated.mdx @@ -0,0 +1,9 @@ + + + + +The Cloud Development Kit for Terraform is deprecated as of December 10, 2025. HashiCorp no longer supports or maintains the Cloud Development Kit for Terraform. + + + + \ No newline at end of file diff --git a/content/terraform-cdk/v0.19.x/docs/partials/deprecated.mdx b/content/terraform-cdk/v0.19.x/docs/partials/deprecated.mdx new file mode 100644 index 0000000000..d61a331b46 --- /dev/null +++ b/content/terraform-cdk/v0.19.x/docs/partials/deprecated.mdx @@ -0,0 +1,9 @@ + + + + +The Cloud Development Kit for Terraform is deprecated as of December 10, 2025. HashiCorp no longer supports or maintains the Cloud Development Kit for Terraform. + + + + \ No newline at end of file diff --git a/content/terraform-cdk/v0.20.x/docs/partials/deprecated.mdx b/content/terraform-cdk/v0.20.x/docs/partials/deprecated.mdx new file mode 100644 index 0000000000..d61a331b46 --- /dev/null +++ b/content/terraform-cdk/v0.20.x/docs/partials/deprecated.mdx @@ -0,0 +1,9 @@ + + + + +The Cloud Development Kit for Terraform is deprecated as of December 10, 2025. HashiCorp no longer supports or maintains the Cloud Development Kit for Terraform. + + + + \ No newline at end of file diff --git a/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/csharp/classes.mdx b/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/csharp/classes.mdx index 1f256682fc..c12e29883d 100644 --- a/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/csharp/classes.mdx +++ b/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/csharp/classes.mdx @@ -7,6 +7,8 @@ description: CDKTF Core API Reference for Classes in CSharp. # CSharp: Classes +@include 'deprecated.mdx' + ### Annotations Includes API for attaching annotations such as warning messages to constructs. diff --git a/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/csharp/constructs.mdx b/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/csharp/constructs.mdx index 01fe700fd2..384a249950 100644 --- a/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/csharp/constructs.mdx +++ b/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/csharp/constructs.mdx @@ -7,6 +7,8 @@ description: CDKTF Core API Reference for Constructs in CSharp. # CSharp: Constructs +@include 'deprecated.mdx' + ### App Represents a cdktf application. diff --git a/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/csharp/enums.mdx b/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/csharp/enums.mdx index f418d93d72..c5329e161b 100644 --- a/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/csharp/enums.mdx +++ b/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/csharp/enums.mdx @@ -7,6 +7,8 @@ description: CDKTF Core API Reference for Enums in CSharp. # CSharp: Enums +@include 'deprecated.mdx' + ### AnnotationMetadataEntryType #### Members diff --git a/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/csharp/index.mdx b/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/csharp/index.mdx index e0d1c78c5f..7b579b189e 100644 --- a/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/csharp/index.mdx +++ b/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/csharp/index.mdx @@ -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) diff --git a/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/csharp/protocols.mdx b/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/csharp/protocols.mdx index d2440b2b0c..f9a7e210b1 100644 --- a/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/csharp/protocols.mdx +++ b/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/csharp/protocols.mdx @@ -7,6 +7,8 @@ description: CDKTF Core API Reference for Protocols in CSharp. # CSharp: Protocols +@include 'deprecated.mdx' + ### IAnyProducer - _Implemented By:_ IAnyProducer diff --git a/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/csharp/structs.mdx b/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/csharp/structs.mdx index ffcaa87a7b..55444806f8 100644 --- a/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/csharp/structs.mdx +++ b/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/csharp/structs.mdx @@ -7,6 +7,8 @@ description: CDKTF Core API Reference for Structs in CSharp. # CSharp: Structs +@include 'deprecated.mdx' + ### AppConfig #### Initializer diff --git a/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/go/classes.mdx b/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/go/classes.mdx index edf70c78e5..19e02c834e 100644 --- a/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/go/classes.mdx +++ b/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/go/classes.mdx @@ -7,6 +7,8 @@ description: CDKTF Core API Reference for Classes in Go. # Go: Classes +@include 'deprecated.mdx' + ### Annotations Includes API for attaching annotations such as warning messages to constructs. diff --git a/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/go/constructs.mdx b/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/go/constructs.mdx index 416e4952c9..1d2f319bda 100644 --- a/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/go/constructs.mdx +++ b/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/go/constructs.mdx @@ -7,6 +7,8 @@ description: CDKTF Core API Reference for Constructs in Go. # Go: Constructs +@include 'deprecated.mdx' + ### App Represents a cdktf application. diff --git a/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/go/enums.mdx b/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/go/enums.mdx index 8510e5bd84..fba2a61953 100644 --- a/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/go/enums.mdx +++ b/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/go/enums.mdx @@ -7,6 +7,8 @@ description: CDKTF Core API Reference for Enums in Go. # Go: Enums +@include 'deprecated.mdx' + ### AnnotationMetadataEntryType #### Members diff --git a/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/go/index.mdx b/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/go/index.mdx index ee2ae4abc5..cf1c6cf779 100644 --- a/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/go/index.mdx +++ b/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/go/index.mdx @@ -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) diff --git a/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/go/protocols.mdx b/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/go/protocols.mdx index 45b96e8e1c..2f9d4baa38 100644 --- a/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/go/protocols.mdx +++ b/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/go/protocols.mdx @@ -7,6 +7,8 @@ description: CDKTF Core API Reference for Protocols in Go. # Go: Protocols +@include 'deprecated.mdx' + ### IAnyProducer - _Implemented By:_ IAnyProducer diff --git a/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/go/structs.mdx b/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/go/structs.mdx index 9fd84c7a33..7e7ce49b97 100644 --- a/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/go/structs.mdx +++ b/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/go/structs.mdx @@ -7,6 +7,8 @@ description: CDKTF Core API Reference for Structs in Go. # Go: Structs +@include 'deprecated.mdx' + ### AppConfig #### Initializer diff --git a/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/index.mdx b/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/index.mdx index 527b674f79..6855dddf56 100644 --- a/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/index.mdx +++ b/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/index.mdx @@ -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) diff --git a/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/java/classes.mdx b/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/java/classes.mdx index d7fa583678..0a36c5140b 100644 --- a/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/java/classes.mdx +++ b/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/java/classes.mdx @@ -7,6 +7,8 @@ description: CDKTF Core API Reference for Classes in Java. # Java: Classes +@include 'deprecated.mdx' + ### Annotations Includes API for attaching annotations such as warning messages to constructs. diff --git a/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/java/constructs.mdx b/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/java/constructs.mdx index 9423b528dc..ae09f52b2e 100644 --- a/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/java/constructs.mdx +++ b/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/java/constructs.mdx @@ -7,6 +7,8 @@ description: CDKTF Core API Reference for Constructs in Java. # Java: Constructs +@include 'deprecated.mdx' + ### App Represents a cdktf application. diff --git a/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/java/enums.mdx b/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/java/enums.mdx index 973c9b44bc..9434cad626 100644 --- a/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/java/enums.mdx +++ b/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/java/enums.mdx @@ -7,6 +7,8 @@ description: CDKTF Core API Reference for Enums in Java. # Java: Enums +@include 'deprecated.mdx' + ### AnnotationMetadataEntryType #### Members diff --git a/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/java/index.mdx b/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/java/index.mdx index bc7517fc9c..b80ad03a08 100644 --- a/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/java/index.mdx +++ b/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/java/index.mdx @@ -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) diff --git a/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/java/protocols.mdx b/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/java/protocols.mdx index eea6bf1759..5febd2c03a 100644 --- a/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/java/protocols.mdx +++ b/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/java/protocols.mdx @@ -7,6 +7,8 @@ description: CDKTF Core API Reference for Protocols in Java. # Java: Protocols +@include 'deprecated.mdx' + ### IAnyProducer - _Implemented By:_ IAnyProducer diff --git a/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/java/structs.mdx b/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/java/structs.mdx index 6c4b3e7a9f..3459b112be 100644 --- a/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/java/structs.mdx +++ b/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/java/structs.mdx @@ -7,6 +7,8 @@ description: CDKTF Core API Reference for Structs in Java. # Java: Structs +@include 'deprecated.mdx' + ### AppConfig #### Initializer diff --git a/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/provider.mdx b/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/provider.mdx index e5b75e7827..14e8877d9b 100644 --- a/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/provider.mdx +++ b/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/provider.mdx @@ -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). diff --git a/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/python/classes.mdx b/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/python/classes.mdx index 4f34815ff8..767826cff1 100644 --- a/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/python/classes.mdx +++ b/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/python/classes.mdx @@ -7,6 +7,8 @@ description: CDKTF Core API Reference for Classes in Python. # Python: Classes +@include 'deprecated.mdx' + ### Annotations Includes API for attaching annotations such as warning messages to constructs. diff --git a/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/python/constructs.mdx b/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/python/constructs.mdx index 789fe7e800..09c65a6c69 100644 --- a/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/python/constructs.mdx +++ b/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/python/constructs.mdx @@ -7,6 +7,8 @@ description: CDKTF Core API Reference for Constructs in Python. # Python: Constructs +@include 'deprecated.mdx' + ### App Represents a cdktf application. diff --git a/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/python/enums.mdx b/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/python/enums.mdx index 6d950c42a6..7d8ad7ec59 100644 --- a/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/python/enums.mdx +++ b/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/python/enums.mdx @@ -7,6 +7,8 @@ description: CDKTF Core API Reference for Enums in Python. # Python: Enums +@include 'deprecated.mdx' + ### AnnotationMetadataEntryType #### Members diff --git a/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/python/index.mdx b/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/python/index.mdx index 9012118732..df5e675998 100644 --- a/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/python/index.mdx +++ b/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/python/index.mdx @@ -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) diff --git a/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/python/protocols.mdx b/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/python/protocols.mdx index 91a88174ca..b6f2d03c2b 100644 --- a/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/python/protocols.mdx +++ b/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/python/protocols.mdx @@ -7,6 +7,8 @@ description: CDKTF Core API Reference for Protocols in Python. # Python: Protocols +@include 'deprecated.mdx' + ### IAnyProducer - _Implemented By:_ IAnyProducer diff --git a/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/python/structs.mdx b/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/python/structs.mdx index 71c33c3a65..cf891009f6 100644 --- a/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/python/structs.mdx +++ b/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/python/structs.mdx @@ -7,6 +7,8 @@ description: CDKTF Core API Reference for Structs in Python. # Python: Structs +@include 'deprecated.mdx' + ### AppConfig #### Initializer diff --git a/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/typescript/classes.mdx b/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/typescript/classes.mdx index ed21651f18..28b7e99b54 100644 --- a/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/typescript/classes.mdx +++ b/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/typescript/classes.mdx @@ -7,6 +7,8 @@ description: CDKTF Core API Reference for Classes in Typescript. # Typescript: Classes +@include 'deprecated.mdx' + ### Annotations Includes API for attaching annotations such as warning messages to constructs. diff --git a/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/typescript/constructs.mdx b/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/typescript/constructs.mdx index dde4209862..4c5450aa14 100644 --- a/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/typescript/constructs.mdx +++ b/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/typescript/constructs.mdx @@ -7,6 +7,8 @@ description: CDKTF Core API Reference for Constructs in Typescript. # Typescript: Constructs +@include 'deprecated.mdx' + ### App Represents a cdktf application. diff --git a/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/typescript/enums.mdx b/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/typescript/enums.mdx index 9bb340d243..34e72957d5 100644 --- a/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/typescript/enums.mdx +++ b/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/typescript/enums.mdx @@ -7,6 +7,8 @@ description: CDKTF Core API Reference for Enums in Typescript. # Typescript: Enums +@include 'deprecated.mdx' + ### AnnotationMetadataEntryType #### Members diff --git a/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/typescript/index.mdx b/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/typescript/index.mdx index 2c1c80ee00..87e3179076 100644 --- a/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/typescript/index.mdx +++ b/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/typescript/index.mdx @@ -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) diff --git a/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/typescript/protocols.mdx b/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/typescript/protocols.mdx index d01802d100..61386d625e 100644 --- a/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/typescript/protocols.mdx +++ b/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/typescript/protocols.mdx @@ -7,6 +7,8 @@ description: CDKTF Core API Reference for Protocols in Typescript. # Typescript: Protocols +@include 'deprecated.mdx' + ### IAnyProducer - _Implemented By:_ IAnyProducer diff --git a/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/typescript/structs.mdx b/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/typescript/structs.mdx index 5430c366a8..da980812ec 100644 --- a/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/typescript/structs.mdx +++ b/content/terraform-cdk/v0.21.x/docs/cdktf/api-reference/typescript/structs.mdx @@ -7,6 +7,8 @@ description: CDKTF Core API Reference for Structs in Typescript. # Typescript: Structs +@include 'deprecated.mdx' + ### AppConfig #### Initializer diff --git a/content/terraform-cdk/v0.21.x/docs/cdktf/cli-reference/cli-configuration.mdx b/content/terraform-cdk/v0.21.x/docs/cdktf/cli-reference/cli-configuration.mdx index 76c13d2639..2f0b6ee219 100644 --- a/content/terraform-cdk/v0.21.x/docs/cdktf/cli-reference/cli-configuration.mdx +++ b/content/terraform-cdk/v0.21.x/docs/cdktf/cli-reference/cli-configuration.mdx @@ -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 diff --git a/content/terraform-cdk/v0.21.x/docs/cdktf/cli-reference/commands.mdx b/content/terraform-cdk/v0.21.x/docs/cdktf/cli-reference/commands.mdx index ebdf330db0..6c0328b0f9 100644 --- a/content/terraform-cdk/v0.21.x/docs/cdktf/cli-reference/commands.mdx +++ b/content/terraform-cdk/v0.21.x/docs/cdktf/cli-reference/commands.mdx @@ -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) diff --git a/content/terraform-cdk/v0.21.x/docs/cdktf/community.mdx b/content/terraform-cdk/v0.21.x/docs/cdktf/community.mdx index ab1fdeb609..3fc1eb4b89 100644 --- a/content/terraform-cdk/v0.21.x/docs/cdktf/community.mdx +++ b/content/terraform-cdk/v0.21.x/docs/cdktf/community.mdx @@ -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 diff --git a/content/terraform-cdk/v0.21.x/docs/cdktf/concepts/aspects.mdx b/content/terraform-cdk/v0.21.x/docs/cdktf/concepts/aspects.mdx index 5f93249497..64f5a8f14f 100644 --- a/content/terraform-cdk/v0.21.x/docs/cdktf/concepts/aspects.mdx +++ b/content/terraform-cdk/v0.21.x/docs/cdktf/concepts/aspects.mdx @@ -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 diff --git a/content/terraform-cdk/v0.21.x/docs/cdktf/concepts/assets.mdx b/content/terraform-cdk/v0.21.x/docs/cdktf/concepts/assets.mdx index 7499ab9e47..a8ceb46725 100644 --- a/content/terraform-cdk/v0.21.x/docs/cdktf/concepts/assets.mdx +++ b/content/terraform-cdk/v0.21.x/docs/cdktf/concepts/assets.mdx @@ -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: @@ -16,8 +18,6 @@ Assets are especially useful for: ## Usage Example -> **Hands-on:** Try the [Deploy Multiple Lambda Functions with TypeScript](/terraform/tutorials/cdktf/cdktf-assets-stacks-lambda) tutorial. This tutorial guides you through using a `TerraformAsset` to archive a Lambda function, uploading the archive to an S3 bucket, then deploying the Lambda function. - The following example uses `TerraformAsset` to upload the contents of the specified directory into an S3 Bucket. The `TerraformAsset` is responsible for making sure the directory ends up in the correct output folder as a zip file that the `S3BucketObject` can reference. The stack output directory in `cdktf.out` contains all of the assets that `TerraformAsset` needs. This is important for workflows where you use synthesized configurations with Terraform directly. For example, you would only need to upload the contents of the stack output folder to HCP Terraform or Terraform Enterprise. diff --git a/content/terraform-cdk/v0.21.x/docs/cdktf/concepts/cdktf-architecture.mdx b/content/terraform-cdk/v0.21.x/docs/cdktf/concepts/cdktf-architecture.mdx index 231dcb8cce..9abda26c4a 100644 --- a/content/terraform-cdk/v0.21.x/docs/cdktf/concepts/cdktf-architecture.mdx +++ b/content/terraform-cdk/v0.21.x/docs/cdktf/concepts/cdktf-architecture.mdx @@ -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 diff --git a/content/terraform-cdk/v0.21.x/docs/cdktf/concepts/constructs.mdx b/content/terraform-cdk/v0.21.x/docs/cdktf/concepts/constructs.mdx index 08d125e9a8..19fa468a68 100644 --- a/content/terraform-cdk/v0.21.x/docs/cdktf/concepts/constructs.mdx +++ b/content/terraform-cdk/v0.21.x/docs/cdktf/concepts/constructs.mdx @@ -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. @@ -347,8 +349,6 @@ The Cloud Development Kit community has identified three major construct types t ## Use Constructs -> **Hands On:** Try [Deploy Applications with CDK for Terraform](/terraform/tutorials/cdktf/cdktf-applications) tutorial to use a custom construct. It includes the example code below. - You can import any [CDKTF-compatible](#available-constructs) construct that is available in your project's programming language. Then, you can create new instances of the construct and use any exposed properties to customize the construct configuration. The following example instantiates a construct called `KubernetesWebAppDeployment` and uses the available arguments to specify that the deployment will have two replicas. diff --git a/content/terraform-cdk/v0.21.x/docs/cdktf/concepts/data-sources.mdx b/content/terraform-cdk/v0.21.x/docs/cdktf/concepts/data-sources.mdx index 0c84666780..c33521fab2 100644 --- a/content/terraform-cdk/v0.21.x/docs/cdktf/concepts/data-sources.mdx +++ b/content/terraform-cdk/v0.21.x/docs/cdktf/concepts/data-sources.mdx @@ -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 diff --git a/content/terraform-cdk/v0.21.x/docs/cdktf/concepts/functions.mdx b/content/terraform-cdk/v0.21.x/docs/cdktf/concepts/functions.mdx index f690e4c6ee..150839b632 100644 --- a/content/terraform-cdk/v0.21.x/docs/cdktf/concepts/functions.mdx +++ b/content/terraform-cdk/v0.21.x/docs/cdktf/concepts/functions.mdx @@ -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. diff --git a/content/terraform-cdk/v0.21.x/docs/cdktf/concepts/hcl-interoperability.mdx b/content/terraform-cdk/v0.21.x/docs/cdktf/concepts/hcl-interoperability.mdx index 34b53dba64..c97f4ad10e 100644 --- a/content/terraform-cdk/v0.21.x/docs/cdktf/concepts/hcl-interoperability.mdx +++ b/content/terraform-cdk/v0.21.x/docs/cdktf/concepts/hcl-interoperability.mdx @@ -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`. diff --git a/content/terraform-cdk/v0.21.x/docs/cdktf/concepts/iterators.mdx b/content/terraform-cdk/v0.21.x/docs/cdktf/concepts/iterators.mdx index a4e45721cb..68ef3ac3b6 100644 --- a/content/terraform-cdk/v0.21.x/docs/cdktf/concepts/iterators.mdx +++ b/content/terraform-cdk/v0.21.x/docs/cdktf/concepts/iterators.mdx @@ -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 diff --git a/content/terraform-cdk/v0.21.x/docs/cdktf/concepts/modules.mdx b/content/terraform-cdk/v0.21.x/docs/cdktf/concepts/modules.mdx index 2f15efa846..674507e5e7 100644 --- a/content/terraform-cdk/v0.21.x/docs/cdktf/concepts/modules.mdx +++ b/content/terraform-cdk/v0.21.x/docs/cdktf/concepts/modules.mdx @@ -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. diff --git a/content/terraform-cdk/v0.21.x/docs/cdktf/concepts/providers.mdx b/content/terraform-cdk/v0.21.x/docs/cdktf/concepts/providers.mdx index 1fac925e7e..76bc843395 100644 --- a/content/terraform-cdk/v0.21.x/docs/cdktf/concepts/providers.mdx +++ b/content/terraform-cdk/v0.21.x/docs/cdktf/concepts/providers.mdx @@ -7,6 +7,8 @@ description: >- # Providers +@include 'deprecated.mdx' + A [provider](/terraform/language/providers) is a plugin that lets Terraform manage an external API. In your CDK for Terraform (CDKTF) application, you use your preferred programming language to define the [resources](/terraform/cdktf/concepts/resources) you want Terraform to manage on one or more providers. You can install pre-built providers packaged with the required code bindings for your language or add providers to the [`cdktf.json`](/terraform/cdktf/create-and-deploy/configuration-file) file and generate code bindings manually. To use providers in your application, you can import them from the Terraform Registry or from your local machine. diff --git a/content/terraform-cdk/v0.21.x/docs/cdktf/concepts/remote-backends.mdx b/content/terraform-cdk/v0.21.x/docs/cdktf/concepts/remote-backends.mdx index faf1a214eb..df13f6e721 100644 --- a/content/terraform-cdk/v0.21.x/docs/cdktf/concepts/remote-backends.mdx +++ b/content/terraform-cdk/v0.21.x/docs/cdktf/concepts/remote-backends.mdx @@ -7,6 +7,8 @@ description: >- # Remote Backends +@include 'deprecated.mdx' + Terraform stores [state](/terraform/language/state) about managed infrastructure to map real-world resources to the configuration, keep track of metadata, and improve performance. Terraform stores this state in a local file by default, but you can also use a Terraform [remote backend](/terraform/language/settings/backends/remote) to store state remotely. By default, `cdktf init` will configure a HCP Terraform workspace and a corresponding remote backend to store state for the new project. If you run `cdktf init --local` to configure your new project to use a local backend to store state, you can still [migrate the state](#migrate-local-state-storage-to-remote) to a remote backend later. diff --git a/content/terraform-cdk/v0.21.x/docs/cdktf/concepts/resources.mdx b/content/terraform-cdk/v0.21.x/docs/cdktf/concepts/resources.mdx index f962011d88..fec2600fbf 100644 --- a/content/terraform-cdk/v0.21.x/docs/cdktf/concepts/resources.mdx +++ b/content/terraform-cdk/v0.21.x/docs/cdktf/concepts/resources.mdx @@ -6,6 +6,8 @@ description: >- # Resources +@include 'deprecated.mdx' + Resources are the most important element when defining infrastructure in CDKTF applications. Each resource describes one or more infrastructure objects, such as virtual networks, compute instances, or higher-level components such as DNS records. In your CDK for Terraform (CDKTF) application, you will use your preferred programming language to define the resources you want Terraform to manage on one or more [providers](/terraform/cdktf/concepts/providers). This page explains how to use resources in your application and how to use [escape hatches](#escape-hatch) to change resource behavior when necessary. diff --git a/content/terraform-cdk/v0.21.x/docs/cdktf/concepts/stacks.mdx b/content/terraform-cdk/v0.21.x/docs/cdktf/concepts/stacks.mdx index 4c04c2bb88..71498f5e87 100644 --- a/content/terraform-cdk/v0.21.x/docs/cdktf/concepts/stacks.mdx +++ b/content/terraform-cdk/v0.21.x/docs/cdktf/concepts/stacks.mdx @@ -7,10 +7,11 @@ description: >- # Stacks +@include 'deprecated.mdx' + A stack represents a collection of infrastructure that CDK for Terraform (CDKTF) synthesizes as a dedicated Terraform configuration. Stacks allow you to separate the state management for multiple environments within an application. > **Note**: Stacks in CDKTF are different from the Terraform stacks concept announced at HashiConf 2023. Terraform stacks are a configuration layer that simplifies provisioning and managing resources at scale by controlling cross-configuration dependencies between Terraform modules. Refer to [Terraform stacks, explained](https://www.hashicorp.com/blog/terraform-stacks-explained) in the HashiCorp blog for additional information. -> **Hands-on:** Try the [Deploy Applications with CDK for Terraform](/terraform/tutorials/cdktf/cdktf-applications?utm_source=WEBSITE&utm_medium=WEB_IO&utm_offer=ARTICLE_PAGE&utm_content=DOCS) tutorial. ## Scope diff --git a/content/terraform-cdk/v0.21.x/docs/cdktf/concepts/tokens.mdx b/content/terraform-cdk/v0.21.x/docs/cdktf/concepts/tokens.mdx index 9625b45373..a55be5cd44 100644 --- a/content/terraform-cdk/v0.21.x/docs/cdktf/concepts/tokens.mdx +++ b/content/terraform-cdk/v0.21.x/docs/cdktf/concepts/tokens.mdx @@ -7,6 +7,8 @@ description: >- # Tokens +@include 'deprecated.mdx' + Tokens represent values that are unknown until Terraform applies your configuration. For example, names of cloud resources are only assigned upon creation. Some attributes specified using CDK for Terraform (CDKTF) may not directly map to the values required for Terraform configurations. You can use [Tokens](https://docs.aws.amazon.com/cdk/latest/guide/tokens.html) to cast these attributes to the correct Terraform language syntax. diff --git a/content/terraform-cdk/v0.21.x/docs/cdktf/concepts/variables-and-outputs.mdx b/content/terraform-cdk/v0.21.x/docs/cdktf/concepts/variables-and-outputs.mdx index 7079b74b5c..c864f3cc75 100644 --- a/content/terraform-cdk/v0.21.x/docs/cdktf/concepts/variables-and-outputs.mdx +++ b/content/terraform-cdk/v0.21.x/docs/cdktf/concepts/variables-and-outputs.mdx @@ -7,6 +7,8 @@ description: >- # Variables and Outputs +@include 'deprecated.mdx' + Terraform can understand configurations written in either HashiCorp Configuration Language (HCL) syntax or JSON. Because neither of these is a programming language, Terraform has developed ways to enable users to request and publish named values. These are: - [**Input Variables:**](#input-variables) These are like function arguments. diff --git a/content/terraform-cdk/v0.21.x/docs/cdktf/create-and-deploy/aws-adapter.mdx b/content/terraform-cdk/v0.21.x/docs/cdktf/create-and-deploy/aws-adapter.mdx index 4b85c3b402..dd0b42a14e 100644 --- a/content/terraform-cdk/v0.21.x/docs/cdktf/create-and-deploy/aws-adapter.mdx +++ b/content/terraform-cdk/v0.21.x/docs/cdktf/create-and-deploy/aws-adapter.mdx @@ -5,6 +5,8 @@ description: "[technical preview] Use AWS CDK (v2) constructs in CDK for Terrafo # \[technical preview] AWS Adapter +@include 'deprecated.mdx' + -> **Note:** The AWS Adapter is a technical preview and not ready for production usage. Its API is not stable and things might break unexpectedly. The `AwsTerraformAdapter` is included in the [`@cdktf/aws-cdk`](https://github.com/hashicorp/cdktf-aws-cdk) package and allows you to use Amazon Web Services Cloud Development Kit (AWS CDK) constructs in your CDK for Terraform (CDKTF) projects. diff --git a/content/terraform-cdk/v0.21.x/docs/cdktf/create-and-deploy/best-practices.mdx b/content/terraform-cdk/v0.21.x/docs/cdktf/create-and-deploy/best-practices.mdx index 84aeea7ad3..9193de32f2 100644 --- a/content/terraform-cdk/v0.21.x/docs/cdktf/create-and-deploy/best-practices.mdx +++ b/content/terraform-cdk/v0.21.x/docs/cdktf/create-and-deploy/best-practices.mdx @@ -5,6 +5,8 @@ description: Build robust applications for production use cases. How to manage s # CDK for Terraform Best Practices +@include 'deprecated.mdx' + There are many ways to structure your CDK for Terraform (CDKTF) application. The structure you choose depends largely on the best practices for your chosen programming language and your use case. However, we recommend using the following principles to build robust, production-ready applications. ## Read Secrets with Terraform Variables diff --git a/content/terraform-cdk/v0.21.x/docs/cdktf/create-and-deploy/configuration-file.mdx b/content/terraform-cdk/v0.21.x/docs/cdktf/create-and-deploy/configuration-file.mdx index 601a19697c..8cc31811e3 100644 --- a/content/terraform-cdk/v0.21.x/docs/cdktf/create-and-deploy/configuration-file.mdx +++ b/content/terraform-cdk/v0.21.x/docs/cdktf/create-and-deploy/configuration-file.mdx @@ -7,6 +7,8 @@ description: >- # Configuration File +@include 'deprecated.mdx' + The `cdktf.json` file is where you can supply custom configuration settings for your application and define the [providers](/terraform/cdktf/concepts/providers) and [modules](/terraform/cdktf/concepts/modules) that you want to use. When you initialize a new CDK for Terraform project with a [built-in template](/terraform/cdktf/create-and-deploy/project-setup), the template generates a basic `cdktf.json` file in your root directory that you can customize for your application. Refer to the [Project Setup documentation](/terraform/cdktf/create-and-deploy/project-setup) for more information about initializing a new project. ## Specification diff --git a/content/terraform-cdk/v0.21.x/docs/cdktf/create-and-deploy/deployment-patterns.mdx b/content/terraform-cdk/v0.21.x/docs/cdktf/create-and-deploy/deployment-patterns.mdx index dc8d8b51fd..71877720dc 100644 --- a/content/terraform-cdk/v0.21.x/docs/cdktf/create-and-deploy/deployment-patterns.mdx +++ b/content/terraform-cdk/v0.21.x/docs/cdktf/create-and-deploy/deployment-patterns.mdx @@ -6,6 +6,8 @@ description: >- # Deployment Patterns +@include 'deprecated.mdx' + You can configure your Continuous Integration/Continuous Deployment (CI/CD) environment to automatically deploy your CDKTF applications. This page explains different types of deployment patterns to help you choose the methods that are most appropriate for your use case. ## Deployment Methods diff --git a/content/terraform-cdk/v0.21.x/docs/cdktf/create-and-deploy/environment-variables.mdx b/content/terraform-cdk/v0.21.x/docs/cdktf/create-and-deploy/environment-variables.mdx index 9b8e0f66ab..8c5dd0d092 100644 --- a/content/terraform-cdk/v0.21.x/docs/cdktf/create-and-deploy/environment-variables.mdx +++ b/content/terraform-cdk/v0.21.x/docs/cdktf/create-and-deploy/environment-variables.mdx @@ -7,6 +7,8 @@ description: >- # Environment Variables +@include 'deprecated.mdx' + Use these environment variables to configure CDK for Terraform (CDKTF) behavior. | Variable Name | Description | Default | diff --git a/content/terraform-cdk/v0.21.x/docs/cdktf/create-and-deploy/hcp-terraform.mdx b/content/terraform-cdk/v0.21.x/docs/cdktf/create-and-deploy/hcp-terraform.mdx index a0eddb34f9..3b67f9c2e8 100644 --- a/content/terraform-cdk/v0.21.x/docs/cdktf/create-and-deploy/hcp-terraform.mdx +++ b/content/terraform-cdk/v0.21.x/docs/cdktf/create-and-deploy/hcp-terraform.mdx @@ -6,9 +6,9 @@ description: >- # Connect to HCP Terraform / Terraform Enterprise -This page explains how to connect HCP Terraform / Terraform Enterprise to your CDK for Terraform (CDKTF) application and the benefits of using these products together. +@include 'deprecated.mdx' -> **Hands On:** Try our [Get Started - HCP Terraform](/terraform/tutorials/cloud-get-started) tutorials. +This page explains how to connect HCP Terraform / Terraform Enterprise to your CDK for Terraform (CDKTF) application and the benefits of using these products together. ## What are HCP Terraform and Terraform Enterprise? diff --git a/content/terraform-cdk/v0.21.x/docs/cdktf/create-and-deploy/performance.mdx b/content/terraform-cdk/v0.21.x/docs/cdktf/create-and-deploy/performance.mdx index 068366c05b..c163135164 100644 --- a/content/terraform-cdk/v0.21.x/docs/cdktf/create-and-deploy/performance.mdx +++ b/content/terraform-cdk/v0.21.x/docs/cdktf/create-and-deploy/performance.mdx @@ -5,6 +5,8 @@ description: The faster you can synthesize your CDKTF code, the faster you can d # Synthesization Performance +@include 'deprecated.mdx' + The faster you can synthesize your CDKTF code, the faster you can deploy it. This page focuses on how to optimize your CDK for Terraform performance. diff --git a/content/terraform-cdk/v0.21.x/docs/cdktf/create-and-deploy/project-setup.mdx b/content/terraform-cdk/v0.21.x/docs/cdktf/create-and-deploy/project-setup.mdx index e2fa4c5557..0090efb6a9 100644 --- a/content/terraform-cdk/v0.21.x/docs/cdktf/create-and-deploy/project-setup.mdx +++ b/content/terraform-cdk/v0.21.x/docs/cdktf/create-and-deploy/project-setup.mdx @@ -7,9 +7,9 @@ description: >- # Project Setup -There are several ways to create a new CDK for Terraform (CDKTF) project. You can create a new application from a pre-built or a custom template, and you can also convert an existing HCL project. When you create a new project, you can store Terraform state locally or use a [remote backend](/terraform/cdktf/concepts/remote-backends). This page discusses these setup options in more detail. +@include 'deprecated.mdx' -> **Hands On**: Try the [CDK for Terraform Quick Start Demo](/terraform/tutorials/cdktf/cdktf-install) and language-specific [Get Started tutorials](/terraform/tutorials/cdktf). +There are several ways to create a new CDK for Terraform (CDKTF) project. You can create a new application from a pre-built or a custom template, and you can also convert an existing HCL project. When you create a new project, you can store Terraform state locally or use a [remote backend](/terraform/cdktf/concepts/remote-backends). This page discusses these setup options in more detail. ## Initialize Project from a Template diff --git a/content/terraform-cdk/v0.21.x/docs/cdktf/create-and-deploy/remote-templates.mdx b/content/terraform-cdk/v0.21.x/docs/cdktf/create-and-deploy/remote-templates.mdx index ef9bec8d11..8467439bba 100644 --- a/content/terraform-cdk/v0.21.x/docs/cdktf/create-and-deploy/remote-templates.mdx +++ b/content/terraform-cdk/v0.21.x/docs/cdktf/create-and-deploy/remote-templates.mdx @@ -7,6 +7,8 @@ description: >- # Remote Templates +@include 'deprecated.mdx' + When you set up a new project via `cdktf init`, you can supply one of the [built-in templates](https://github.com/hashicorp/terraform-cdk/tree/main/packages/%40cdktf/cli-core/templates) (e.g. `typescript` or `python`) or use a custom-built remote template. Templates scaffold a new CDK for Terraform (CDKTF) project, creating the necessary directories and files. ## Create Remote Templates diff --git a/content/terraform-cdk/v0.21.x/docs/cdktf/develop-custom-constructs/construct-design.mdx b/content/terraform-cdk/v0.21.x/docs/cdktf/develop-custom-constructs/construct-design.mdx index 51a31e43bb..fb7f16bb95 100644 --- a/content/terraform-cdk/v0.21.x/docs/cdktf/develop-custom-constructs/construct-design.mdx +++ b/content/terraform-cdk/v0.21.x/docs/cdktf/develop-custom-constructs/construct-design.mdx @@ -6,6 +6,8 @@ description: |- # Construct Design +@include 'deprecated.mdx' + Custom construct classes are reusable infrastructure configurations written in a programming language. Similar to [Terraform modules](/terraform/language/modules), constructs let you reuse configurations, enforce infrastructure best practices, and abstract configuration details away from users. For example, you might create a construct that configures a Kubernetes deployment. diff --git a/content/terraform-cdk/v0.21.x/docs/cdktf/develop-custom-constructs/publishing-and-distribution.mdx b/content/terraform-cdk/v0.21.x/docs/cdktf/develop-custom-constructs/publishing-and-distribution.mdx index ba90c211b9..d1485e0265 100644 --- a/content/terraform-cdk/v0.21.x/docs/cdktf/develop-custom-constructs/publishing-and-distribution.mdx +++ b/content/terraform-cdk/v0.21.x/docs/cdktf/develop-custom-constructs/publishing-and-distribution.mdx @@ -6,6 +6,8 @@ description: |- # Construct Publishing and Distribution +@include 'deprecated.mdx' + Custom construct classes are reusable infrastructure configurations written in a programming language. After you [write a custom construct](/terraform/cdktf/develop-custom-constructs/construct-design), you can translate it to multiple languages and publish it for others to import and use in CDK for Terraform (CDKTF) applications. ## Translate Constructs to Terraform Modules diff --git a/content/terraform-cdk/v0.21.x/docs/cdktf/examples-and-guides/examples.mdx b/content/terraform-cdk/v0.21.x/docs/cdktf/examples-and-guides/examples.mdx index e37b17077f..c063b5af2d 100644 --- a/content/terraform-cdk/v0.21.x/docs/cdktf/examples-and-guides/examples.mdx +++ b/content/terraform-cdk/v0.21.x/docs/cdktf/examples-and-guides/examples.mdx @@ -7,18 +7,9 @@ description: >- # Examples -This page contains links to tutorials, example projects in every supported language, explanatory videos, and other resources to help you learn to create and manage CDK for Terraform (CDKTF) applications. - -## Tutorials +@include 'deprecated.mdx' -Follow these hands-on tutorials: - -| Tutorial | Description | -| ----------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| [Install CDKTF and Run a Quick Start Demo](/terraform/tutorials/cdktf/cdktf-install) | Write TypeScript code that will provision an NGINX server using Docker on Mac, Windows, or Linux. | -| [Build AWS Infrastructure with TypeScript, Python, Java, C#, or Go](/terraform/tutorials/cdktf/cdktf-build) | Provision an EC2 instance on AWS using TypeScript. | -| [Deploy Multiple Lambda Functions with TypeScript](/terraform/tutorials/cdktf/cdktf-assets-stacks-lambda) | Deploy a CDKTF application made up of two stacks, each containing a simple AWS Lambda function written in TypeScript. | -| [Deploy Applications with CDK for Terraform](/terraform/tutorials/cdktf/cdktf-applications) | Use CDKTF to deploy an application on Kubernetes. | +This page contains links to tutorials, example projects in every supported language, explanatory videos, and other resources to help you learn to create and manage CDK for Terraform (CDKTF) applications. ## Example Projects diff --git a/content/terraform-cdk/v0.21.x/docs/cdktf/examples-and-guides/refactoring.mdx b/content/terraform-cdk/v0.21.x/docs/cdktf/examples-and-guides/refactoring.mdx index 5567df234c..7094fad7e5 100644 --- a/content/terraform-cdk/v0.21.x/docs/cdktf/examples-and-guides/refactoring.mdx +++ b/content/terraform-cdk/v0.21.x/docs/cdktf/examples-and-guides/refactoring.mdx @@ -6,6 +6,8 @@ description: >- # Refactoring +@include 'deprecated.mdx' + You may need to move resources between stacks as your CDK for Terraform (CDKTF) application grows in size and complexity. This guide demonstrates how to refactor your stacks. In general you can change the names of stacks freely without an effect on the synthesized code. If you change the name of a resource this might lead to a re-creation of the resource, especially if you move the resource from one stack to another. ## Moving & Renaming Resources Within a Stack diff --git a/content/terraform-cdk/v0.21.x/docs/cdktf/index.mdx b/content/terraform-cdk/v0.21.x/docs/cdktf/index.mdx index 1de09e99c5..6af28c108c 100644 --- a/content/terraform-cdk/v0.21.x/docs/cdktf/index.mdx +++ b/content/terraform-cdk/v0.21.x/docs/cdktf/index.mdx @@ -7,6 +7,8 @@ description: >- # CDK for Terraform +@include 'deprecated.mdx' + Cloud Development Kit for Terraform (CDKTF) allows you to use familiar programming languages to define and provision infrastructure. This gives you access to the entire Terraform ecosystem without learning HashiCorp Configuration Language (HCL) and lets you leverage the power of your existing toolchain for testing, dependency management, etc. We support TypeScript, Python, Java, C#, and Go. @@ -43,6 +45,5 @@ If you plan to create and package your own constructs, we recommend choosing Typ ## Get Started -- [Install CDKTF](/terraform/tutorials/cdktf/cdktf-install) and set up your first project. - Learn about [CDKTF application architecture](/terraform/cdktf/concepts/cdktf-architecture). - Learn how to use key CDKTF concepts like [providers](/terraform/cdktf/concepts/providers), [modules](/terraform/cdktf/concepts/modules), and [resources](/terraform/cdktf/concepts/resources) to define infrastructure. diff --git a/content/terraform-cdk/v0.21.x/docs/cdktf/release/index.mdx b/content/terraform-cdk/v0.21.x/docs/cdktf/release/index.mdx index d259b6c53c..fb29c9f8ce 100644 --- a/content/terraform-cdk/v0.21.x/docs/cdktf/release/index.mdx +++ b/content/terraform-cdk/v0.21.x/docs/cdktf/release/index.mdx @@ -6,6 +6,8 @@ description: >- # Releases +@include 'deprecated.mdx' + We release CDK for Terraform (CDKTF) regularly. The [CHANGELOG on Github](https://github.com/hashicorp/terraform-cdk/blob/main/CHANGELOG.md) contains details about bug fixes, new features, and deprecations. ## Upgrade Guides diff --git a/content/terraform-cdk/v0.21.x/docs/cdktf/release/upgrade-guide-v0-10.mdx b/content/terraform-cdk/v0.21.x/docs/cdktf/release/upgrade-guide-v0-10.mdx index 0131620303..b703eed927 100644 --- a/content/terraform-cdk/v0.21.x/docs/cdktf/release/upgrade-guide-v0-10.mdx +++ b/content/terraform-cdk/v0.21.x/docs/cdktf/release/upgrade-guide-v0-10.mdx @@ -6,6 +6,8 @@ description: >- # Upgrading to CDK for Terraform Version 0.10 +@include 'deprecated.mdx' + 0.10 includes improvements to the provider code bindings, to allow referencing lists of computed attributes as a whole list instead of just individual items of that list. We also shipped a lot of CLI improvements in 0.10, including support for multiple stacks in `cdktf deploy`, `cdktf output`, and `cdktf destroy`. diff --git a/content/terraform-cdk/v0.21.x/docs/cdktf/release/upgrade-guide-v0-11.mdx b/content/terraform-cdk/v0.21.x/docs/cdktf/release/upgrade-guide-v0-11.mdx index 5c16aa0ab2..0144a0e1fb 100644 --- a/content/terraform-cdk/v0.21.x/docs/cdktf/release/upgrade-guide-v0-11.mdx +++ b/content/terraform-cdk/v0.21.x/docs/cdktf/release/upgrade-guide-v0-11.mdx @@ -6,6 +6,8 @@ description: >- # Upgrading to CDK for Terraform Version 0.11 +@include 'deprecated.mdx' + 0.11 includes improvements to the provider code bindings, to allow referencing maps of computed attributes as a whole map instead of just individual items of that map. Both lists and maps now allow accessing all computed attributes of an assignable property. More control over logging was also added. diff --git a/content/terraform-cdk/v0.21.x/docs/cdktf/release/upgrade-guide-v0-12.mdx b/content/terraform-cdk/v0.21.x/docs/cdktf/release/upgrade-guide-v0-12.mdx index f9dab1d272..4e5188f26e 100644 --- a/content/terraform-cdk/v0.21.x/docs/cdktf/release/upgrade-guide-v0-12.mdx +++ b/content/terraform-cdk/v0.21.x/docs/cdktf/release/upgrade-guide-v0-12.mdx @@ -6,6 +6,8 @@ description: >- # Upgrading to CDK for Terraform Version 0.12 +@include 'deprecated.mdx' + 0.12 includes improvements to the provider code bindings, allowing for shorter attribute names for recursive attributes. diff --git a/content/terraform-cdk/v0.21.x/docs/cdktf/release/upgrade-guide-v0-13.mdx b/content/terraform-cdk/v0.21.x/docs/cdktf/release/upgrade-guide-v0-13.mdx index aba8030581..2c7a53d89e 100644 --- a/content/terraform-cdk/v0.21.x/docs/cdktf/release/upgrade-guide-v0-13.mdx +++ b/content/terraform-cdk/v0.21.x/docs/cdktf/release/upgrade-guide-v0-13.mdx @@ -6,6 +6,8 @@ description: >- # Upgrading to CDK for Terraform Version 0.13 +@include 'deprecated.mdx' + 0.13 includes performance improvements to generated providers. Instead of exporting a flat list of exports including all supported resources and data sources, we now export each construct and it's associated structures in their own namespace. Due to this, the way you import constructs from your CDKTF application will change. diff --git a/content/terraform-cdk/v0.21.x/docs/cdktf/release/upgrade-guide-v0-15.mdx b/content/terraform-cdk/v0.21.x/docs/cdktf/release/upgrade-guide-v0-15.mdx index e5291061ec..26d9ca77f5 100644 --- a/content/terraform-cdk/v0.21.x/docs/cdktf/release/upgrade-guide-v0-15.mdx +++ b/content/terraform-cdk/v0.21.x/docs/cdktf/release/upgrade-guide-v0-15.mdx @@ -6,6 +6,8 @@ description: >- # Upgrading to CDK for Terraform Version 0.15 +@include 'deprecated.mdx' + 0.15 is primarily focused around CLI improvements targeted at a better HCP Terraform integration. Because of this, there are only smaller breaking changes in this release. The most notable one is a renaming of some interfaces / classes in our core library. Some configuration classes were suffixed inconsistently with `Config`, `Props` or `Options` and were renamed to `Config` for consistency. These classes need to be used in C#, Java, and Go, therefore we have a breaking change in these languages. diff --git a/content/terraform-cdk/v0.21.x/docs/cdktf/release/upgrade-guide-v0-17.mdx b/content/terraform-cdk/v0.21.x/docs/cdktf/release/upgrade-guide-v0-17.mdx index 73b5ff0ea3..ced111e149 100644 --- a/content/terraform-cdk/v0.21.x/docs/cdktf/release/upgrade-guide-v0-17.mdx +++ b/content/terraform-cdk/v0.21.x/docs/cdktf/release/upgrade-guide-v0-17.mdx @@ -6,6 +6,8 @@ description: >- # Upgrading to CDK for Terraform Version 0.17 +@include 'deprecated.mdx' + 0.17 is focused around fixing issues with the [AWS Quicksight](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/quicksight_template) resources. We also removed the deprecated feature flags that were used to enable potentially breaking changes in previous releases. If you encounter breaking changes from the removal of these feature flags, use the `MigrateIds` `Aspect` at the root of your affected stacks to migrate resources to use the current form of id generation without their recreation. diff --git a/content/terraform-cdk/v0.21.x/docs/cdktf/release/upgrade-guide-v0-18.mdx b/content/terraform-cdk/v0.21.x/docs/cdktf/release/upgrade-guide-v0-18.mdx index 767f010702..8031f9a62f 100644 --- a/content/terraform-cdk/v0.21.x/docs/cdktf/release/upgrade-guide-v0-18.mdx +++ b/content/terraform-cdk/v0.21.x/docs/cdktf/release/upgrade-guide-v0-18.mdx @@ -6,6 +6,8 @@ description: >- # Upgrading to CDK for Terraform Version 0.18 +@include 'deprecated.mdx' + 0.18 brings performance improvements to CDKTF along with improvements to the `convert` command. ### Python performance improvements disable root-level provider imports diff --git a/content/terraform-cdk/v0.21.x/docs/cdktf/release/upgrade-guide-v0-19.mdx b/content/terraform-cdk/v0.21.x/docs/cdktf/release/upgrade-guide-v0-19.mdx index 80aa3f59b3..4d97dcc654 100644 --- a/content/terraform-cdk/v0.21.x/docs/cdktf/release/upgrade-guide-v0-19.mdx +++ b/content/terraform-cdk/v0.21.x/docs/cdktf/release/upgrade-guide-v0-19.mdx @@ -6,6 +6,8 @@ description: >- # Upgrading to CDK for Terraform Version 0.19 +@include 'deprecated.mdx' + 0.19 brings new workflows to import existing resources from cloud providers and refactor exisiting resources in your CDKTF project. ### Minimum required Node.js version updated to 18.12 diff --git a/content/terraform-cdk/v0.21.x/docs/cdktf/release/upgrade-guide-v0-6.mdx b/content/terraform-cdk/v0.21.x/docs/cdktf/release/upgrade-guide-v0-6.mdx index e8be185cb6..67c4515c30 100644 --- a/content/terraform-cdk/v0.21.x/docs/cdktf/release/upgrade-guide-v0-6.mdx +++ b/content/terraform-cdk/v0.21.x/docs/cdktf/release/upgrade-guide-v0-6.mdx @@ -6,6 +6,8 @@ description: >- # Upgrading to CDK for Terraform Version 0.6 +@include 'deprecated.mdx' + CDK for Terraform version 0.6 uses [`constructs`](https://github.com/aws/constructs) version 10. If you are using more advanced APIs from the `constructs` library, refer to the [Constructs API Changes](#constructs-api-changes) section. ## Background diff --git a/content/terraform-cdk/v0.21.x/docs/cdktf/release/upgrade-guide-v0-7.mdx b/content/terraform-cdk/v0.21.x/docs/cdktf/release/upgrade-guide-v0-7.mdx index 55509e8eda..410d0be067 100644 --- a/content/terraform-cdk/v0.21.x/docs/cdktf/release/upgrade-guide-v0-7.mdx +++ b/content/terraform-cdk/v0.21.x/docs/cdktf/release/upgrade-guide-v0-7.mdx @@ -6,6 +6,8 @@ description: >- # Upgrading to CDK for Terraform Version 0.7 +@include 'deprecated.mdx' + Update your import statements for the AWS provider and learn to migrate your projects. ## AWS Provider has namespaced resources diff --git a/content/terraform-cdk/v0.21.x/docs/cdktf/release/upgrade-guide-v0-9.mdx b/content/terraform-cdk/v0.21.x/docs/cdktf/release/upgrade-guide-v0-9.mdx index 0f25b1f4b7..a8675b4f2c 100644 --- a/content/terraform-cdk/v0.21.x/docs/cdktf/release/upgrade-guide-v0-9.mdx +++ b/content/terraform-cdk/v0.21.x/docs/cdktf/release/upgrade-guide-v0-9.mdx @@ -6,6 +6,8 @@ description: >- # Upgrading to CDK for Terraform Version 0.9 +@include 'deprecated.mdx' + 0.9 includes improvements to some of our provider code bindings, to improve usage across all languages. ### Standardize IResolvable Usage diff --git a/content/terraform-cdk/v0.21.x/docs/cdktf/telemetry.mdx b/content/terraform-cdk/v0.21.x/docs/cdktf/telemetry.mdx index da3d2c4eff..5c53bfc6d9 100644 --- a/content/terraform-cdk/v0.21.x/docs/cdktf/telemetry.mdx +++ b/content/terraform-cdk/v0.21.x/docs/cdktf/telemetry.mdx @@ -7,6 +7,8 @@ description: >- # Telemetry +@include 'deprecated.mdx' + The [CDK for Terraform CLI](/terraform/cdktf/cli-reference/cli-configuration) interacts with a HashiCorp service called [Checkpoint](https://checkpoint.hashicorp.com) to report project metrics such as cdktf version, project language, provider name, platform name, and other details that help guide the project maintainers with feature and roadmap decisions. All HashiCorp projects, including Terraform Core, use Checkpoint. Read more about project metrics [in this issue](https://github.com/hashicorp/terraform-cdk/issues/325). Starting with CDK for Terraform 0.6, this information includes a random UUID that uniquely identifies the machine, and new projects will have a project-specific UUID added to the `cdktf.json` file. The purpose of these UUIDs is to help team understand how the tool is used in order to help us prioritize features. The [code that interacts with Checkpoint](https://github.com/hashicorp/terraform-cdk/blob/main/packages/%40cdktf/commons/src/checkpoint.ts) is part of CDK for Terraform CLI. diff --git a/content/terraform-cdk/v0.21.x/docs/cdktf/test/debugging.mdx b/content/terraform-cdk/v0.21.x/docs/cdktf/test/debugging.mdx index 755bf90f70..46c39b7fdd 100644 --- a/content/terraform-cdk/v0.21.x/docs/cdktf/test/debugging.mdx +++ b/content/terraform-cdk/v0.21.x/docs/cdktf/test/debugging.mdx @@ -6,6 +6,8 @@ description: >- # Debugging +@include 'deprecated.mdx' + To debug your CDKTF application, we recommend first turning on logging. Then, determine whether the issue occurs when your configuration is synthesized or when Terraform attempts to provision your infrastructure. ## Logging diff --git a/content/terraform-cdk/v0.21.x/docs/cdktf/test/unit-tests.mdx b/content/terraform-cdk/v0.21.x/docs/cdktf/test/unit-tests.mdx index 380c26b127..00bd91ff27 100644 --- a/content/terraform-cdk/v0.21.x/docs/cdktf/test/unit-tests.mdx +++ b/content/terraform-cdk/v0.21.x/docs/cdktf/test/unit-tests.mdx @@ -5,6 +5,8 @@ description: Write assertions and snapshot tests for your CDK for Terraform appl # Unit Tests +@include 'deprecated.mdx' + Testing your application can give you faster feedback cycles and guard you against unwanted changes. Testing is currently supported in Typescript with jest and compatible with any testing framework that supports assertions for all other languages. We generate all files necessary to start testing when you run `cdktf init` so that you can start writing tests right away. diff --git a/content/terraform-cdk/v0.21.x/docs/partials/deprecated.mdx b/content/terraform-cdk/v0.21.x/docs/partials/deprecated.mdx new file mode 100644 index 0000000000..d61a331b46 --- /dev/null +++ b/content/terraform-cdk/v0.21.x/docs/partials/deprecated.mdx @@ -0,0 +1,9 @@ + + + + +The Cloud Development Kit for Terraform is deprecated as of December 10, 2025. HashiCorp no longer supports or maintains the Cloud Development Kit for Terraform. + + + + \ No newline at end of file