https://github.com/hashicorp/cdktf-aws-cdk

Use AWS CDK constructs in CDKTF projects
https://github.com/hashicorp/cdktf-aws-cdk

aws-cdk cdk cdktf constructs terraform terraform-cdk

Last synced: 7 days ago
JSON representation

Use AWS CDK constructs in CDKTF projects

• Host: GitHub
• URL: https://github.com/hashicorp/cdktf-aws-cdk
• Owner: hashicorp
• License: mpl-2.0
• Created: 2021-10-08T13:10:16.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2025-01-06T10:55:05.000Z (16 days ago)
• Last Synced: 2025-01-08T02:07:05.085Z (14 days ago)
• Topics: aws-cdk, cdk, cdktf, constructs, terraform, terraform-cdk
• Language: TypeScript
• Homepage:
• Size: 73.3 MB
• Stars: 95
• Watchers: 12
• Forks: 14
• Open Issues: 17
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS
  • Security: docs/securityGroup.md
  • Support: .github/SUPPORT.md

Awesome Lists containing this project

README

        
# [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`](https://www.terraform.io/docs/providers/aws/r/cloudcontrolapi_resource.html) Terraform resource to communicate with the [AWS Cloud Control API](https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/what-is-cloudcontrolapi.html). Reference this [list of supported resources](https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/supported-resources.html) 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](https://github.com/hashicorp/cdktf-aws-cdk/tree/main/src/mapping/aws) 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.20.0

- `aws-cdk-lib` >= 2.80.0

- `constructs` >= 10.0.25

```

npm install @cdktf/aws-cdk

```

## Docs

Read the [docs on HashiCorp Developer](https://developer.hashicorp.com/terraform/cdktf/create-and-deploy/aws-adapter).

Find auto-generated API docs for this package [here](./docs/API.md).