> ## 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: DataResource > CDKTN Core API Reference for DataResource in Typescript. The DataResource implements the standard resource lifecycle, but does not directly take any other actions. You can use the DataResource resource without requiring or configuring a provider. The DataResource resource is useful for storing values which need to follow a manage resource lifecycle, and for triggering provisioners when there is no other logical managed resource in which to place them. It requires Terraform 1.4 or later. It is also possible to generate these bindings by adding "terraform.io/builtin/terraform" to the "terraformProviders" key in your cdktf.json file and running "cdktn get". [https://developer.hashicorp.com/terraform/language/resources/terraform-data](https://developer.hashicorp.com/terraform/language/resources/terraform-data) ## Initializers ```typescript theme={null} import { DataResource } from 'cdktn' new DataResource(scope: Construct, id: string, config?: DataConfig) ``` | **Name** | **Type** | **Description** | | ---------------------------------------------------------------------------------- | ------------------------------------------------------- | -------------------------------------------- | | scope | constructs.Construct | The scope in which to define this construct. | | id | string | The scoped construct ID. | | config | DataConfig | *No description.* | *** ### `scope`^Required * *Type:* constructs.Construct The scope in which to define this construct. *** ### `id`^Required * *Type:* string The scoped construct ID. Must be unique amongst siblings in the same scope *** ### `config`^Optional * *Type:* DataConfig *** ## Methods | **Name** | **Description** | | -------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | addOverride | *No description.* | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | resetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. | | toHclTerraform | *No description.* | | toMetadata | *No description.* | | toTerraform | Adds this resource to the terraform JSON output. | | addMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. | | getAnyMapAttribute | *No description.* | | getBooleanAttribute | *No description.* | | getBooleanMapAttribute | *No description.* | | getListAttribute | *No description.* | | getNumberAttribute | *No description.* | | getNumberListAttribute | *No description.* | | getNumberMapAttribute | *No description.* | | getStringAttribute | *No description.* | | getStringMapAttribute | *No description.* | | hasResourceMove | *No description.* | | importFrom | *No description.* | | interpolationForAttribute | *No description.* | | moveFromId | Move the resource corresponding to "id" to this resource. | | moveTo | Moves this resource to the target resource given by moveTarget. | | moveToId | Moves this resource to the resource corresponding to "id". | | resetInput | *No description.* | | resetTriggersReplace | *No description.* | *** ### `toString` ```typescript theme={null} public toString(): string ``` Returns a string representation of this construct. ### `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`^Required * *Type:* ...constructs.IMixin\[] The mixins to apply. *** ### `addOverride` ```typescript theme={null} public addOverride(path: string, value: any): void ``` #### `path`^Required * *Type:* string *** #### `value`^Required * *Type:* any *** ### `overrideLogicalId` ```typescript theme={null} public overrideLogicalId(newLogicalId: string): void ``` Overrides the auto-generated logical ID with a specific ID. #### `newLogicalId`^Required * *Type:* string The new logical ID to use for this stack element. *** ### `resetOverrideLogicalId` ```typescript theme={null} public resetOverrideLogicalId(): void ``` Resets a previously passed logical Id to use the auto-generated logical id again. ### `toHclTerraform` ```typescript theme={null} public toHclTerraform(): any ``` ### `toMetadata` ```typescript theme={null} public toMetadata(): any ``` ### `toTerraform` ```typescript theme={null} public toTerraform(): any ``` Adds this resource to the terraform JSON output. ### `addMoveTarget` ```typescript theme={null} public addMoveTarget(moveTarget: string): void ``` Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. #### `moveTarget`^Required * *Type:* string The string move target that will correspond to this resource. *** ### `getAnyMapAttribute` ```typescript theme={null} public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any} ``` #### `terraformAttribute`^Required * *Type:* string *** ### `getBooleanAttribute` ```typescript theme={null} public getBooleanAttribute(terraformAttribute: string): IResolvable ``` #### `terraformAttribute`^Required * *Type:* string *** ### `getBooleanMapAttribute` ```typescript theme={null} public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean} ``` #### `terraformAttribute`^Required * *Type:* string *** ### `getListAttribute` ```typescript theme={null} public getListAttribute(terraformAttribute: string): string[] ``` #### `terraformAttribute`^Required * *Type:* string *** ### `getNumberAttribute` ```typescript theme={null} public getNumberAttribute(terraformAttribute: string): number ``` #### `terraformAttribute`^Required * *Type:* string *** ### `getNumberListAttribute` ```typescript theme={null} public getNumberListAttribute(terraformAttribute: string): number[] ``` #### `terraformAttribute`^Required * *Type:* string *** ### `getNumberMapAttribute` ```typescript theme={null} public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number} ``` #### `terraformAttribute`^Required * *Type:* string *** ### `getStringAttribute` ```typescript theme={null} public getStringAttribute(terraformAttribute: string): string ``` #### `terraformAttribute`^Required * *Type:* string *** ### `getStringMapAttribute` ```typescript theme={null} public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string} ``` #### `terraformAttribute`^Required * *Type:* string *** ### `hasResourceMove` ```typescript theme={null} public hasResourceMove(): TerraformResourceMoveByTarget | TerraformResourceMoveById ``` ### `importFrom` ```typescript theme={null} public importFrom(id: string, provider?: TerraformProvider): void ``` #### `id`^Required * *Type:* string *** #### `provider`^Optional * *Type:* TerraformProvider *** ### `interpolationForAttribute` ```typescript theme={null} public interpolationForAttribute(terraformAttribute: string): IResolvable ``` #### `terraformAttribute`^Required * *Type:* string *** ### `moveFromId` ```typescript theme={null} public moveFromId(id: string): void ``` Move the resource corresponding to "id" to this resource. Note that the resource being moved from must be marked as moved using it's instance function. #### `id`^Required * *Type:* string Full id of resource being moved from, e.g. "aws\_s3\_bucket.example". *** ### `moveTo` ```typescript theme={null} public moveTo(moveTarget: string, index?: string | number): void ``` Moves this resource to the target resource given by moveTarget. #### `moveTarget`^Required * *Type:* string The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to. *** #### `index`^Optional * *Type:* string | number Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to. *** ### `moveToId` ```typescript theme={null} public moveToId(id: string): void ``` Moves this resource to the resource corresponding to "id". #### `id`^Required * *Type:* string Full id of resource to move to, e.g. "aws\_s3\_bucket.example". *** ### `resetInput` ```typescript theme={null} public resetInput(): void ``` ### `resetTriggersReplace` ```typescript theme={null} public resetTriggersReplace(): void ``` ## Static Functions | **Name** | **Description** | | ---------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | | isConstruct | Checks if `x` is a construct. | | isTerraformElement | *No description.* | | isTerraformResource | *No description.* | | generateConfigForImport | Generates CDKTN code for importing a Data resource upon running "cdktn plan \< stack-name >". | *** ### `isConstruct` ```typescript theme={null} import { DataResource } from 'cdktn' DataResource.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`^Required * *Type:* any Any object. *** ### `isTerraformElement` ```typescript theme={null} import { DataResource } from 'cdktn' DataResource.isTerraformElement(x: any) ``` #### `x`^Required * *Type:* any *** ### `isTerraformResource` ```typescript theme={null} import { DataResource } from 'cdktn' DataResource.isTerraformResource(x: any) ``` #### `x`^Required * *Type:* any *** ### `generateConfigForImport` ```typescript theme={null} import { DataResource } from 'cdktn' DataResource.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider) ``` Generates CDKTN code for importing a Data resource upon running "cdktn plan \< stack-name >". #### `scope`^Required * *Type:* constructs.Construct The scope in which to define this construct. *** #### `importToId`^Required * *Type:* string The construct id used in the generated config for the Data to import. *** #### `importFromId`^Required * *Type:* string The id of the existing Data that should be imported. Refer to the [import section](https://terraform.io/providers/builtin/terraform/latest/docs/resources/data#import) in the documentation of this resource for the id to use *** #### `provider`^Optional * *Type:* TerraformProvider ? Optional instance of the provider where the Data to import is found. *** ## Properties | **Name** | **Type** | **Description** | | ------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | | node | constructs.Node | The tree node. | | cdktfStack | TerraformStack | *No description.* | | fqn | string | *No description.* | | friendlyUniqueId | string | *No description.* | | terraformMetaArguments | \{\[ key: string ]: any} | *No description.* | | terraformResourceType | string | *No description.* | | terraformGeneratorMetadata | TerraformProviderGeneratorMetadata | *No description.* | | connection | SSHProvisionerConnection \| WinrmProvisionerConnection | *No description.* | | count | number \| TerraformCount | *No description.* | | dependsOn | string\[] | *No description.* | | forEach | ITerraformIterator | *No description.* | | lifecycle | TerraformResourceLifecycle | *No description.* | | provider | TerraformProvider | *No description.* | | provisioners | FileProvisioner \| LocalExecProvisioner \| RemoteExecProvisioner\[] | *No description.* | | id | string | *No description.* | | output | AnyMap | *No description.* | | inputInput | \{\[ key: string ]: any} | *No description.* | | triggersReplaceInput | \{\[ key: string ]: any} | *No description.* | | input | \{\[ key: string ]: any} | (Optional) A value which will be stored in the instance state, and reflected in the output attribute after apply. | | triggersReplace | \{\[ key: string ]: any} | (Optional) A value which is stored in the instance state, and will force replacement when the value changes. | *** ### `node`^Required ```typescript theme={null} public readonly node: Node; ``` * *Type:* constructs.Node The tree node. *** ### `cdktfStack`^Required ```typescript theme={null} public readonly cdktfStack: TerraformStack; ``` * *Type:* TerraformStack *** ### `fqn`^Required ```typescript theme={null} public readonly fqn: string; ``` * *Type:* string *** ### `friendlyUniqueId`^Required ```typescript theme={null} public readonly friendlyUniqueId: string; ``` * *Type:* string *** ### `terraformMetaArguments`^Required ```typescript theme={null} public readonly terraformMetaArguments: {[ key: string ]: any}; ``` * *Type:* \{\[ key: string ]: any} *** ### `terraformResourceType`^Required ```typescript theme={null} public readonly terraformResourceType: string; ``` * *Type:* string *** ### `terraformGeneratorMetadata`^Optional ```typescript theme={null} public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata; ``` * *Type:* TerraformProviderGeneratorMetadata *** ### `connection`^Optional ```typescript theme={null} public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection; ``` * *Type:* SSHProvisionerConnection | WinrmProvisionerConnection *** ### `count`^Optional ```typescript theme={null} public readonly count: number | TerraformCount; ``` * *Type:* number | TerraformCount *** ### `dependsOn`^Optional ```typescript theme={null} public readonly dependsOn: string[]; ``` * *Type:* string\[] *** ### `forEach`^Optional ```typescript theme={null} public readonly forEach: ITerraformIterator; ``` * *Type:* ITerraformIterator *** ### `lifecycle`^Optional ```typescript theme={null} public readonly lifecycle: TerraformResourceLifecycle; ``` * *Type:* TerraformResourceLifecycle *** ### `provider`^Optional ```typescript theme={null} public readonly provider: TerraformProvider; ``` * *Type:* TerraformProvider *** ### `provisioners`^Optional ```typescript theme={null} public readonly provisioners: (FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner)[]; ``` * *Type:* FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner\[] *** ### `id`^Required ```typescript theme={null} public readonly id: string; ``` * *Type:* string *** ### `output`^Required ```typescript theme={null} public readonly output: AnyMap; ``` * *Type:* AnyMap *** ### `inputInput`^Optional ```typescript theme={null} public readonly inputInput: {[ key: string ]: any}; ``` * *Type:* \{\[ key: string ]: any} *** ### `triggersReplaceInput`^Optional ```typescript theme={null} public readonly triggersReplaceInput: {[ key: string ]: any}; ``` * *Type:* \{\[ key: string ]: any} *** ### `input`^Required ```typescript theme={null} public readonly input: {[ key: string ]: any}; ``` * *Type:* \{\[ key: string ]: any} (Optional) A value which will be stored in the instance state, and reflected in the output attribute after apply. [https://developer.hashicorp.com/terraform/language/resources/terraform-data#input](https://developer.hashicorp.com/terraform/language/resources/terraform-data#input) *** ### `triggersReplace`^Required ```typescript theme={null} public readonly triggersReplace: {[ key: string ]: any}; ``` * *Type:* \{\[ key: string ]: any} (Optional) A value which is stored in the instance state, and will force replacement when the value changes. [https://developer.hashicorp.com/terraform/language/resources/terraform-data#triggers\\\_replace](https://developer.hashicorp.com/terraform/language/resources/terraform-data#triggers\\_replace) *** ## Constants | **Name** | **Type** | **Description** | | ------------------------------------------------------------------------------------- | ------------------- | ----------------- | | tfResourceType | string | *No description.* | *** ### `tfResourceType`^Required ```typescript theme={null} public readonly tfResourceType: string; ``` * *Type:* string ***