/cdktf-aws-cdk

Use AWS CDK constructs in CDKTF projects

Primary LanguageTypeScriptMozilla Public License 2.0MPL-2.0

[technical preview] AWS Adapter

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 (included in the @cdktf/aws-cdk package) allows you to use Amazon Web Services Cloud Development Kit (AWS CDK) constructs in your CDK for Terraform (CDKTF) projects.

The AwsTerraformAdapter uses the aws_cloudcontrolapi_resource Terraform resource to communicate with the AWS Cloud Control API. Reference this list of supported resources for the Cloud Control API.

You need to manually map resources that the AWS Cloud Control API does not yet support to specific Terraform resources because attribute names and resource types differ between CloudFormation and Terraform. Some manual mappings are already included in the adapter. Manual mappings will become obsolete over time as AWS Cloud Control API expands its coverage. In the meantime, we are happy to accept PRs adding manual mappings for currently unsupported resources!

Requirements

The AwsTerraformAdapter currently only supports TypeScript projects:

  • node >= 18.12.0
  • cdktf >= 0.18.0
  • aws-cdk-lib >= 2.80.0
  • constructs >= 10.0.25
npm install @cdktf/aws-cdk

Docs

Read the docs on HashiCorp Developer.

Find auto-generated API docs for this package here.