A new platform for documentation and tutorials is launching soon.
We are migrating Terraform documentation into HashiCorp Developer, our new developer experience.
»CDK for Terraform
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.
»How does CDK for Terraform work?
CDK for Terraform leverages concepts and libraries from the AWS Cloud Development Kit to translate your code into infrastructure configuration files for Terraform.
At a high level, you will:
- Create an Application: Use either a built-in or a custom template to scaffold a project in your chosen language.
- Define Infrastructure: Use your chosen language to define the infrastructure you want to provision on one or more providers. CDKTF automatically extracts the schema from Terraform providers and modules to generate the necessary classes for your application.
- Deploy: Use
cdktfCLI commands to provision infrastructure with Terraform or synthesize your code into a JSON configuration file that others can use with Terraform directly.
You can use every Terraform provider and module available on the Terraform Registry, and you can use CDKTF with Terraform Cloud, Terraform Enterprise, and HashiCorp's policy as code framework, Sentinel.
»When to use CDK for Terraform
CDKTF offers many benefits, but it is not the right choice for every project. You should consider using CDKTF when:
- You have a strong preference or need to use a procedural language to define infrastructure.
- You need to create abstractions to help manage complexity. For example, you want to create constructs to model a reusable infrastructure pattern composed of multiple resources and convenience methods.
- You are comfortable doing your own troubleshooting and do not require commercial support.
You can make this choice for each team and project because CDK for Terraform interoperates with existing Terraform providers and modules.
»Choosing a Language for your Project
Consider which of the supported languages you are most familiar with and which language best fits your organization's current tooling. We work towards providing feature parity and a good user experience across all supported languages, but there may be instances when new experimental features will not be available for all languages.
If you plan to create and package your own constructs, we recommend choosing TypeScript. Using TypeScript allows you to use the cdktf constructs package generator to build and publish your constructs in multiple languages.