Skip to content

remove CDKTF docs post deprecation #351

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
HarshCasper merged 1 commit into from
Dec 15, 2025
Merged

remove CDKTF docs post deprecation #351

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
279 changes: 0 additions & 279 deletions src/content/docs/aws/integrations/infrastructure-as-code/terraform.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -239,285 +239,6 @@ It will detect whether the AWS account ID is `000000000000`, which is the defaul
If you use a different account ID within LocalStack, you can customize the snippet accordingly.
:::

## CDK for Terraform

Cloud Development Kit for Terraform (CDKTF) allows you to use general-purpose programming languages, such as TypeScript, Python, Java, and more, to create infrastructure declaratively.
It allows you to create, update, and delete AWS infrastructure by leveraging a Terraform backend without manually configuring Terraform using HCL and [AWS Cloud Development Kit](https://aws.amazon.com/cdk/) to translate your code into infrastructure configuration files for Terraform.
CDKTF supports every Terraform provider and module available on the [Terraform Registry](https://registry.terraform.io/).

### Configuration

To configure your existing CDKTF configuration to work with LocalStack, manually configure the local service endpoints and credentials.
It includes:

- General configuration to specify mock credentials for the AWS provider (`region`, `access_key`, `secret_key`).
- Request Management to avoid issues with routing and authentication, if needed.
- Service configuration to point the individual services to LocalStack.

Here is a configuration example to use with Python & TypeScript CDKTF configurations:

<Tabs>
<TabItem label="localstack_config.py">
```python showshowLineNumbers
AWS_CONFIG = {
"region": "us-east-1",
"endpoints": [
{
"apigateway": "http://localhost:4566",
"apigatewayv2": "http://localhost:4566",
"cloudformation": "http://localhost:4566",
"cloudwatch": "http://localhost:4566",
"dynamodb": "http://localhost:4566",
"ec2": "http://localhost:4566",
"es": "http://localhost:4566",
"elasticache": "http://localhost:4566",
"firehose": "http://localhost:4566",
"iam": "http://localhost:4566",
"kinesis": "http://localhost:4566",
"lambda": "http://localhost:4566",
"rds": "http://localhost:4566",
"redshift": "http://localhost:4566",
"route53": "http://localhost:4566",
"s3": "http://s3.localhost.localstack.cloud:4566",
"secretsmanager": "http://localhost:4566",
"ses": "http://localhost:4566",
"sns": "http://localhost:4566",
"sqs": "http://localhost:4566",
"ssm": "http://localhost:4566",
"stepfunctions": "http://localhost:4566",
"sts": "http://localhost:4566",
}
],
}
```
</TabItem>
<TabItem label="localstack_config.ts">
```javascript showshowLineNumbers
export const AWS_CONFIG = {
region: "us-east-1",
endpoints: [
{
apigateway: "http://localhost:4566",
apigatewayv2: "http://localhost:4566",
cloudformation: "http://localhost:4566",
cloudwatch: "http://localhost:4566",
dynamodb: "http://localhost:4566",
ec2: "http://localhost:4566",
es: "http://localhost:4566",
elasticache: "http://localhost:4566",
firehose: "http://localhost:4566",
iam: "http://localhost:4566",
kinesis: "http://localhost:4566",
lambda: "http://localhost:4566",
rds: "http://localhost:4566",
redshift: "http://localhost:4566",
route53: "http://localhost:4566",
s3: "http://s3.localhost.localstack.cloud:4566",
secretsmanager: "http://localhost:4566",
ses: "http://localhost:4566",
sns: "http://localhost:4566",
sqs: "http://localhost:4566",
ssm: "http://localhost:4566",
stepfunctions: "http://localhost:4566",
sts: "http://localhost:4566",
},
],
};
```
</TabItem>
</Tabs>

You can further import the above configuration in your project's code, and use it to configure the AWS provider:

<Tabs>
<TabItem label="main.py">
```python showshowLineNumbers
...
from localstack_config import AWS_CONFIG
...
AwsProvider(self, "Aws", **AWS_CONFIG)
...
```
</TabItem>
<TabItem label="main.ts">
```javascript showshowLineNumbers
...
import { AWS_CONFIG } from "./localstack-config";
...
new AwsProvider(this, "aws", AWS_CONFIG);
...
```
</TabItem>
</Tabs>

### Getting started

To get started with CDKTF on LocalStack, we will set up a simple stack to create some AWS resources.
We will then deploy the stack to LocalStack, and verify that the resources have been created successfully.
Before we start, make sure you have the following prerequisites:

- LocalStack
- [`cdktf`](https://www.npmjs.com/package/cdktf)

For Python:

- [`python`](https://www.python.org/downloads/)
- [`pipenv`](https://pipenv.pypa.io/en/latest/installation.html#installing-pipenv)

For TypeScript:

- [`tsc`](https://www.npmjs.com/package/typescript)

Create a new directory named `cdktf-localstack` and initialize a new CDKTF project using the following command:

<Tabs>
<TabItem label="Python">
```python showshowLineNumbers
cdktf init
...
? Do you want to continue with Terraform Cloud remote state management? No
? What template do you want to use? python

Initializing a project using the python template.
? Project Name sample-app
? Project Description A simple getting started project for cdktf.
? Do you want to start from an existing Terraform project? No
? Do you want to send crash reports to the CDKTF team? Refer to https://developer.hashicorp.com/terraform/cdktf/create-and-deploy/configuration-file#enable-crash-reporting-for-the-cli for more information no
Note: You can always add providers using 'cdktf provider add' later on
? What providers do you want to use? aws
...
```
</TabItem>
<TabItem label="TypeScript">
```javascript showshowLineNumbers
cdktf init
...
? Do you want to continue with Terraform Cloud remote state management? No
? What template do you want to use? typescript

Initializing a project using the typescript template.
? Project Name sample-app
? Project Description A simple getting started project for cdktf.
? Do you want to start from an existing Terraform project? No
? Do you want to send crash reports to the CDKTF team? Refer to https://developer.hashicorp.com/terraform/cdktf/create-and-deploy/configuration-file#enable-crash-reporting-for-the-cli for more information no
Note: You can always add providers using 'cdktf provider add' later on
? What providers do you want to use? aws
...
```
</TabItem>
</Tabs>

(Optional) If necessary, we can install the AWS provider separately for CDKTF, by running the following command:

<Tabs>
<TabItem label="Python">
```python
pipenv install cdktf-cdktf-provider-aws
```
</TabItem>
<TabItem label="TypeScript">
```javascript
npm install @cdktf/provider-aws
```
</TabItem>
</Tabs>

Add the following code to import the AWS provider and create a new S3 bucket in the relevant file:

<Tabs>
<TabItem label="main.py">
```python showshowLineNumbers
# !/usr/bin/env python

from constructs import Construct
from cdktf import App, TerraformStack
from cdktf_cdktf_provider_aws.provider import AwsProvider
from cdktf_cdktf_provider_aws.s3_bucket import S3Bucket

class MyStack(TerraformStack):
def **init**(self, scope: Construct, id: str):
super().**init**(scope, id)

AwsProvider(self, "aws",
region="us-east-1",
s3_use_path_style=True,
endpoints=[
{
"s3": "http://localhost:4566",
"sts": "http://localhost:4566",
}
]
)

S3Bucket(self, "bucket")

app = App()
MyStack(app, "cdktf-example-python")

app.synth()
```
</TabItem>
<TabItem label="main.ts">
```javascript showshowLineNumbers
import { Construct } from "constructs";
import { App, TerraformStack } from "cdktf";
import { AwsProvider } from "@cdktf/provider-aws/lib/provider";
import {S3Bucket} from "@cdktf/provider-aws/lib/s3-bucket";

class MyStack extends TerraformStack {
constructor(scope: Construct, id: string) {
super(scope, id);

new AwsProvider(this, "aws",{
region: "us-east-1",
s3UsePathStyle: true,
endpoints: [
{
s3: "http://localhost:4566",
sts: "http://localhost:4566"
},
],
});

new S3Bucket(this, "bucket", {});
}
}

const app = new App();
new MyStack(app, "example");
app.synth();
```
</TabItem>
</Tabs>

Run the following command to compile and deploy the CDKTF stack to LocalStack:

```bash
cdktf synth && cdktf deploy
```

You should see the following output:

```sh showshowLineNumbers
example Initializing the backend...
example
Successfully configured the backend "local"! Terraform will automatically
use this backend unless the backend configuration changes.
...
example aws_s3_bucket.bucket (bucket): Creating...
example aws_s3_bucket.bucket (bucket): Creation complete after 5s [id=terraform-20230418074657926600000001]
example
Apply complete! Resources: 1 added, 0 changed, 0 destroyed.
```

Verify that the S3 bucket has been created successfully by running the following command:

```bash
awslocal s3 ls
```

Your CDKTF stack is now successfully deployed to LocalStack. You can now start using CDKTF to create and manage your AWS resources on LocalStack.

## OpenTofu

OpenTofu is an open-source fork of Terraform acting as a drop-in replacement for Terraform, as it's compatible with Terraform versions 1.5.x and most of 1.6.x. You can use OpenTofu with LocalStack to create and manage your AWS resources with your pre-existing Terraform configurations. You can use the `TF_CMD` environment variable with `tflocal` to specify the `tofu` binary to call, or setup a manual configuration to point the individual services to LocalStack.
Expand Down