> ## Documentation Index
> Fetch the complete documentation index at: https://cdktn.io/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Typescript: TerraformDataSource

> CDKTN Core API Reference for TerraformDataSource in Typescript.

* *Implements:* <a href="#cdktn.ITerraformResource">ITerraformResource</a>, <a href="#cdktn.ITerraformDependable">ITerraformDependable</a>, <a href="#cdktn.IInterpolatingParent">IInterpolatingParent</a>

## Initializers <a name="Initializers" id="cdktn.TerraformDataSource.Initializer" />

```typescript theme={null}
import { TerraformDataSource } from 'cdktn'

new TerraformDataSource(scope: Construct, id: string, config: TerraformResourceConfig)
```

| **Name**                                                                                  | **Type**                                                                          | **Description**   |
| ----------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | ----------------- |
| <code><a href="#cdktn.TerraformDataSource.Initializer.parameter.scope">scope</a></code>   | <code>constructs.Construct</code>                                                 | *No description.* |
| <code><a href="#cdktn.TerraformDataSource.Initializer.parameter.id">id</a></code>         | <code>string</code>                                                               | *No description.* |
| <code><a href="#cdktn.TerraformDataSource.Initializer.parameter.config">config</a></code> | <code><a href="#cdktn.TerraformResourceConfig">TerraformResourceConfig</a></code> | *No description.* |

***

### `scope`<sup>Required</sup> <a name="scope" id="cdktn.TerraformDataSource.Initializer.parameter.scope" />

* *Type:* constructs.Construct

***

### `id`<sup>Required</sup> <a name="id" id="cdktn.TerraformDataSource.Initializer.parameter.id" />

* *Type:* string

***

### `config`<sup>Required</sup> <a name="config" id="cdktn.TerraformDataSource.Initializer.parameter.config" />

* *Type:* <a href="#cdktn.TerraformResourceConfig">TerraformResourceConfig</a>

***

## Methods <a name="Methods" id="Methods" />

| **Name**                                                                                                  | **Description**                                                                   |
| --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- |
| <code><a href="#cdktn.TerraformDataSource.toString">toString</a></code>                                   | Returns a string representation of this construct.                                |
| <code><a href="#cdktn.TerraformDataSource.with">with</a></code>                                           | Applies one or more mixins to this construct.                                     |
| <code><a href="#cdktn.TerraformDataSource.addOverride">addOverride</a></code>                             | *No description.*                                                                 |
| <code><a href="#cdktn.TerraformDataSource.overrideLogicalId">overrideLogicalId</a></code>                 | Overrides the auto-generated logical ID with a specific ID.                       |
| <code><a href="#cdktn.TerraformDataSource.resetOverrideLogicalId">resetOverrideLogicalId</a></code>       | Resets a previously passed logical Id to use the auto-generated logical id again. |
| <code><a href="#cdktn.TerraformDataSource.toHclTerraform">toHclTerraform</a></code>                       | Adds this resource to the terraform JSON output.                                  |
| <code><a href="#cdktn.TerraformDataSource.toMetadata">toMetadata</a></code>                               | *No description.*                                                                 |
| <code><a href="#cdktn.TerraformDataSource.toTerraform">toTerraform</a></code>                             | Adds this resource to the terraform JSON output.                                  |
| <code><a href="#cdktn.TerraformDataSource.getAnyMapAttribute">getAnyMapAttribute</a></code>               | *No description.*                                                                 |
| <code><a href="#cdktn.TerraformDataSource.getBooleanAttribute">getBooleanAttribute</a></code>             | *No description.*                                                                 |
| <code><a href="#cdktn.TerraformDataSource.getBooleanMapAttribute">getBooleanMapAttribute</a></code>       | *No description.*                                                                 |
| <code><a href="#cdktn.TerraformDataSource.getListAttribute">getListAttribute</a></code>                   | *No description.*                                                                 |
| <code><a href="#cdktn.TerraformDataSource.getNumberAttribute">getNumberAttribute</a></code>               | *No description.*                                                                 |
| <code><a href="#cdktn.TerraformDataSource.getNumberListAttribute">getNumberListAttribute</a></code>       | *No description.*                                                                 |
| <code><a href="#cdktn.TerraformDataSource.getNumberMapAttribute">getNumberMapAttribute</a></code>         | *No description.*                                                                 |
| <code><a href="#cdktn.TerraformDataSource.getStringAttribute">getStringAttribute</a></code>               | *No description.*                                                                 |
| <code><a href="#cdktn.TerraformDataSource.getStringMapAttribute">getStringMapAttribute</a></code>         | *No description.*                                                                 |
| <code><a href="#cdktn.TerraformDataSource.interpolationForAttribute">interpolationForAttribute</a></code> | *No description.*                                                                 |

***

### `toString` <a name="toString" id="cdktn.TerraformDataSource.toString" />

```typescript theme={null}
public toString(): string
```

Returns a string representation of this construct.

### `with` <a name="with" id="cdktn.TerraformDataSource.with" />

```typescript theme={null}
public with(mixins: ...IMixin[]): IConstruct
```

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple `with()` calls if subsequent mixins should apply to added
constructs.

#### `mixins`<sup>Required</sup> <a name="mixins" id="cdktn.TerraformDataSource.with.parameter.mixins" />

* *Type:* ...constructs.IMixin\[]

The mixins to apply.

***

### `addOverride` <a name="addOverride" id="cdktn.TerraformDataSource.addOverride" />

```typescript theme={null}
public addOverride(path: string, value: any): void
```

#### `path`<sup>Required</sup> <a name="path" id="cdktn.TerraformDataSource.addOverride.parameter.path" />

* *Type:* string

***

#### `value`<sup>Required</sup> <a name="value" id="cdktn.TerraformDataSource.addOverride.parameter.value" />

* *Type:* any

***

### `overrideLogicalId` <a name="overrideLogicalId" id="cdktn.TerraformDataSource.overrideLogicalId" />

```typescript theme={null}
public overrideLogicalId(newLogicalId: string): void
```

Overrides the auto-generated logical ID with a specific ID.

#### `newLogicalId`<sup>Required</sup> <a name="newLogicalId" id="cdktn.TerraformDataSource.overrideLogicalId.parameter.newLogicalId" />

* *Type:* string

The new logical ID to use for this stack element.

***

### `resetOverrideLogicalId` <a name="resetOverrideLogicalId" id="cdktn.TerraformDataSource.resetOverrideLogicalId" />

```typescript theme={null}
public resetOverrideLogicalId(): void
```

Resets a previously passed logical Id to use the auto-generated logical id again.

### `toHclTerraform` <a name="toHclTerraform" id="cdktn.TerraformDataSource.toHclTerraform" />

```typescript theme={null}
public toHclTerraform(): any
```

Adds this resource to the terraform JSON output.

### `toMetadata` <a name="toMetadata" id="cdktn.TerraformDataSource.toMetadata" />

```typescript theme={null}
public toMetadata(): any
```

### `toTerraform` <a name="toTerraform" id="cdktn.TerraformDataSource.toTerraform" />

```typescript theme={null}
public toTerraform(): any
```

Adds this resource to the terraform JSON output.

### `getAnyMapAttribute` <a name="getAnyMapAttribute" id="cdktn.TerraformDataSource.getAnyMapAttribute" />

```typescript theme={null}
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
```

#### `terraformAttribute`<sup>Required</sup> <a name="terraformAttribute" id="cdktn.TerraformDataSource.getAnyMapAttribute.parameter.terraformAttribute" />

* *Type:* string

***

### `getBooleanAttribute` <a name="getBooleanAttribute" id="cdktn.TerraformDataSource.getBooleanAttribute" />

```typescript theme={null}
public getBooleanAttribute(terraformAttribute: string): IResolvable
```

#### `terraformAttribute`<sup>Required</sup> <a name="terraformAttribute" id="cdktn.TerraformDataSource.getBooleanAttribute.parameter.terraformAttribute" />

* *Type:* string

***

### `getBooleanMapAttribute` <a name="getBooleanMapAttribute" id="cdktn.TerraformDataSource.getBooleanMapAttribute" />

```typescript theme={null}
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
```

#### `terraformAttribute`<sup>Required</sup> <a name="terraformAttribute" id="cdktn.TerraformDataSource.getBooleanMapAttribute.parameter.terraformAttribute" />

* *Type:* string

***

### `getListAttribute` <a name="getListAttribute" id="cdktn.TerraformDataSource.getListAttribute" />

```typescript theme={null}
public getListAttribute(terraformAttribute: string): string[]
```

#### `terraformAttribute`<sup>Required</sup> <a name="terraformAttribute" id="cdktn.TerraformDataSource.getListAttribute.parameter.terraformAttribute" />

* *Type:* string

***

### `getNumberAttribute` <a name="getNumberAttribute" id="cdktn.TerraformDataSource.getNumberAttribute" />

```typescript theme={null}
public getNumberAttribute(terraformAttribute: string): number
```

#### `terraformAttribute`<sup>Required</sup> <a name="terraformAttribute" id="cdktn.TerraformDataSource.getNumberAttribute.parameter.terraformAttribute" />

* *Type:* string

***

### `getNumberListAttribute` <a name="getNumberListAttribute" id="cdktn.TerraformDataSource.getNumberListAttribute" />

```typescript theme={null}
public getNumberListAttribute(terraformAttribute: string): number[]
```

#### `terraformAttribute`<sup>Required</sup> <a name="terraformAttribute" id="cdktn.TerraformDataSource.getNumberListAttribute.parameter.terraformAttribute" />

* *Type:* string

***

### `getNumberMapAttribute` <a name="getNumberMapAttribute" id="cdktn.TerraformDataSource.getNumberMapAttribute" />

```typescript theme={null}
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
```

#### `terraformAttribute`<sup>Required</sup> <a name="terraformAttribute" id="cdktn.TerraformDataSource.getNumberMapAttribute.parameter.terraformAttribute" />

* *Type:* string

***

### `getStringAttribute` <a name="getStringAttribute" id="cdktn.TerraformDataSource.getStringAttribute" />

```typescript theme={null}
public getStringAttribute(terraformAttribute: string): string
```

#### `terraformAttribute`<sup>Required</sup> <a name="terraformAttribute" id="cdktn.TerraformDataSource.getStringAttribute.parameter.terraformAttribute" />

* *Type:* string

***

### `getStringMapAttribute` <a name="getStringMapAttribute" id="cdktn.TerraformDataSource.getStringMapAttribute" />

```typescript theme={null}
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
```

#### `terraformAttribute`<sup>Required</sup> <a name="terraformAttribute" id="cdktn.TerraformDataSource.getStringMapAttribute.parameter.terraformAttribute" />

* *Type:* string

***

### `interpolationForAttribute` <a name="interpolationForAttribute" id="cdktn.TerraformDataSource.interpolationForAttribute" />

```typescript theme={null}
public interpolationForAttribute(terraformAttribute: string): IResolvable
```

#### `terraformAttribute`<sup>Required</sup> <a name="terraformAttribute" id="cdktn.TerraformDataSource.interpolationForAttribute.parameter.terraformAttribute" />

* *Type:* string

***

## Static Functions <a name="Static Functions" id="Static Functions" />

| **Name**                                                                                          | **Description**               |
| ------------------------------------------------------------------------------------------------- | ----------------------------- |
| <code><a href="#cdktn.TerraformDataSource.isConstruct">isConstruct</a></code>                     | Checks if `x` is a construct. |
| <code><a href="#cdktn.TerraformDataSource.isTerraformElement">isTerraformElement</a></code>       | *No description.*             |
| <code><a href="#cdktn.TerraformDataSource.isTerraformDataSource">isTerraformDataSource</a></code> | *No description.*             |

***

### `isConstruct` <a name="isConstruct" id="cdktn.TerraformDataSource.isConstruct" />

```typescript theme={null}
import { TerraformDataSource } from 'cdktn'

TerraformDataSource.isConstruct(x: any)
```

Checks if `x` is a construct.

Use this method instead of `instanceof` to properly detect `Construct`
instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the `constructs` library on
disk are seen as independent, completely different libraries. As a
consequence, the class `Construct` in each copy of the `constructs` library
is seen as a different class, and an instance of one class will not test as
`instanceof` the other class. `npm install` will not create installations
like this, but users may manually symlink construct libraries together or
use a monorepo tool: in those cases, multiple copies of the `constructs`
library can be accidentally installed, and `instanceof` will behave
unpredictably. It is safest to avoid using `instanceof`, and using
this type-testing method instead.

#### `x`<sup>Required</sup> <a name="x" id="cdktn.TerraformDataSource.isConstruct.parameter.x" />

* *Type:* any

Any object.

***

### `isTerraformElement` <a name="isTerraformElement" id="cdktn.TerraformDataSource.isTerraformElement" />

```typescript theme={null}
import { TerraformDataSource } from 'cdktn'

TerraformDataSource.isTerraformElement(x: any)
```

#### `x`<sup>Required</sup> <a name="x" id="cdktn.TerraformDataSource.isTerraformElement.parameter.x" />

* *Type:* any

***

### `isTerraformDataSource` <a name="isTerraformDataSource" id="cdktn.TerraformDataSource.isTerraformDataSource" />

```typescript theme={null}
import { TerraformDataSource } from 'cdktn'

TerraformDataSource.isTerraformDataSource(x: any)
```

#### `x`<sup>Required</sup> <a name="x" id="cdktn.TerraformDataSource.isTerraformDataSource.parameter.x" />

* *Type:* any

***

## Properties <a name="Properties" id="Properties" />

| **Name**                                                                                                             | **Type**                                                                                                | **Description**   |
| -------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ----------------- |
| <code><a href="#cdktn.TerraformDataSource.property.node">node</a></code>                                             | <code>constructs.Node</code>                                                                            | The tree node.    |
| <code><a href="#cdktn.TerraformDataSource.property.cdktfStack">cdktfStack</a></code>                                 | <code><a href="#cdktn.TerraformStack">TerraformStack</a></code>                                         | *No description.* |
| <code><a href="#cdktn.TerraformDataSource.property.fqn">fqn</a></code>                                               | <code>string</code>                                                                                     | *No description.* |
| <code><a href="#cdktn.TerraformDataSource.property.friendlyUniqueId">friendlyUniqueId</a></code>                     | <code>string</code>                                                                                     | *No description.* |
| <code><a href="#cdktn.TerraformDataSource.property.terraformMetaArguments">terraformMetaArguments</a></code>         | <code>\{\[ key: string ]: any}</code>                                                                   | *No description.* |
| <code><a href="#cdktn.TerraformDataSource.property.terraformResourceType">terraformResourceType</a></code>           | <code>string</code>                                                                                     | *No description.* |
| <code><a href="#cdktn.TerraformDataSource.property.terraformGeneratorMetadata">terraformGeneratorMetadata</a></code> | <code><a href="#cdktn.TerraformProviderGeneratorMetadata">TerraformProviderGeneratorMetadata</a></code> | *No description.* |
| <code><a href="#cdktn.TerraformDataSource.property.count">count</a></code>                                           | <code>number \| <a href="#cdktn.TerraformCount">TerraformCount</a></code>                               | *No description.* |
| <code><a href="#cdktn.TerraformDataSource.property.dependsOn">dependsOn</a></code>                                   | <code>string\[]</code>                                                                                  | *No description.* |
| <code><a href="#cdktn.TerraformDataSource.property.forEach">forEach</a></code>                                       | <code><a href="#cdktn.ITerraformIterator">ITerraformIterator</a></code>                                 | *No description.* |
| <code><a href="#cdktn.TerraformDataSource.property.lifecycle">lifecycle</a></code>                                   | <code><a href="#cdktn.TerraformResourceLifecycle">TerraformResourceLifecycle</a></code>                 | *No description.* |
| <code><a href="#cdktn.TerraformDataSource.property.provider">provider</a></code>                                     | <code><a href="#cdktn.TerraformProvider">TerraformProvider</a></code>                                   | *No description.* |

***

### `node`<sup>Required</sup> <a name="node" id="cdktn.TerraformDataSource.property.node" />

```typescript theme={null}
public readonly node: Node;
```

* *Type:* constructs.Node

The tree node.

***

### `cdktfStack`<sup>Required</sup> <a name="cdktfStack" id="cdktn.TerraformDataSource.property.cdktfStack" />

```typescript theme={null}
public readonly cdktfStack: TerraformStack;
```

* *Type:* <a href="#cdktn.TerraformStack">TerraformStack</a>

***

### `fqn`<sup>Required</sup> <a name="fqn" id="cdktn.TerraformDataSource.property.fqn" />

```typescript theme={null}
public readonly fqn: string;
```

* *Type:* string

***

### `friendlyUniqueId`<sup>Required</sup> <a name="friendlyUniqueId" id="cdktn.TerraformDataSource.property.friendlyUniqueId" />

```typescript theme={null}
public readonly friendlyUniqueId: string;
```

* *Type:* string

***

### `terraformMetaArguments`<sup>Required</sup> <a name="terraformMetaArguments" id="cdktn.TerraformDataSource.property.terraformMetaArguments" />

```typescript theme={null}
public readonly terraformMetaArguments: {[ key: string ]: any};
```

* *Type:* \{\[ key: string ]: any}

***

### `terraformResourceType`<sup>Required</sup> <a name="terraformResourceType" id="cdktn.TerraformDataSource.property.terraformResourceType" />

```typescript theme={null}
public readonly terraformResourceType: string;
```

* *Type:* string

***

### `terraformGeneratorMetadata`<sup>Optional</sup> <a name="terraformGeneratorMetadata" id="cdktn.TerraformDataSource.property.terraformGeneratorMetadata" />

```typescript theme={null}
public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;
```

* *Type:* <a href="#cdktn.TerraformProviderGeneratorMetadata">TerraformProviderGeneratorMetadata</a>

***

### `count`<sup>Optional</sup> <a name="count" id="cdktn.TerraformDataSource.property.count" />

```typescript theme={null}
public readonly count: number | TerraformCount;
```

* *Type:* number | <a href="#cdktn.TerraformCount">TerraformCount</a>

***

### `dependsOn`<sup>Optional</sup> <a name="dependsOn" id="cdktn.TerraformDataSource.property.dependsOn" />

```typescript theme={null}
public readonly dependsOn: string[];
```

* *Type:* string\[]

***

### `forEach`<sup>Optional</sup> <a name="forEach" id="cdktn.TerraformDataSource.property.forEach" />

```typescript theme={null}
public readonly forEach: ITerraformIterator;
```

* *Type:* <a href="#cdktn.ITerraformIterator">ITerraformIterator</a>

***

### `lifecycle`<sup>Optional</sup> <a name="lifecycle" id="cdktn.TerraformDataSource.property.lifecycle" />

```typescript theme={null}
public readonly lifecycle: TerraformResourceLifecycle;
```

* *Type:* <a href="#cdktn.TerraformResourceLifecycle">TerraformResourceLifecycle</a>

***

### `provider`<sup>Optional</sup> <a name="provider" id="cdktn.TerraformDataSource.property.provider" />

```typescript theme={null}
public readonly provider: TerraformProvider;
```

* *Type:* <a href="#cdktn.TerraformProvider">TerraformProvider</a>

***
