Package com.hashicorp.cdktf

Class DataResource

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

com.hashicorp.cdktf.TerraformElement

com.hashicorp.cdktf.TerraformResource

com.hashicorp.cdktf.DataResource

All Implemented Interfaces:

IInterpolatingParent, ITerraformAddressable, ITerraformDependable, ITerraformResource, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.93.0 (build 1706ca5)",
           date="2024-01-15T15:38:00.878Z")
@Stability(Experimental)
public class DataResource
extends TerraformResource

(experimental) 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 "cdktf get".

https://developer.hashicorp.com/terraform/language/resources/terraform-data

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	DataResource.Builder	(experimental) A fluent builder for DataResource.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$Proxy

Nested classes/interfaces inherited from interface com.hashicorp.cdktf.IInterpolatingParent

IInterpolatingParent.Jsii$Default, IInterpolatingParent.Jsii$Proxy

Nested classes/interfaces inherited from interface com.hashicorp.cdktf.ITerraformDependable

ITerraformDependable.Jsii$Default, ITerraformDependable.Jsii$Proxy

Nested classes/interfaces inherited from interface com.hashicorp.cdktf.ITerraformResource

ITerraformResource.Jsii$Default, ITerraformResource.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	TF_RESOURCE_TYPE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DataResource(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	DataResource(software.amazon.jsii.JsiiObjectRef objRef)
	DataResource(software.constructs.Construct scope, String id)	(experimental) Create a new TerraformData Resource.
	DataResource(software.constructs.Construct scope, String id, DataConfig config)	(experimental) Create a new TerraformData Resource.

Method Summary

Modifier and Type	Method	Description
static ImportableResource	generateConfigForImport(software.constructs.Construct scope, String importToId, String importFromId)	(experimental) Generates CDKTF code for importing a Data resource upon running "cdktf plan invalid input: '<'stack-name>".
static ImportableResource	generateConfigForImport(software.constructs.Construct scope, String importToId, String importFromId, TerraformProvider provider)	(experimental) Generates CDKTF code for importing a Data resource upon running "cdktf plan invalid input: '<'stack-name>".
String	getId()
Map<String,Object>	getInput()	(experimental) (Optional) A value which will be stored in the instance state, and reflected in the output attribute after apply.
Map<String,Object>	getInputInput()
AnyMap	getOutput()
Map<String,Object>	getTriggersReplace()	(experimental) (Optional) A value which is stored in the instance state, and will force replacement when the value changes.
Map<String,Object>	getTriggersReplaceInput()
void	resetInput()
void	resetTriggersReplace()
void	setInput(Map<String,Object> value)	(experimental) (Optional) A value which will be stored in the instance state, and reflected in the output attribute after apply.
void	setTriggersReplace(Map<String,Object> value)	(experimental) (Optional) A value which is stored in the instance state, and will force replacement when the value changes.
protected Map<String,Object>	synthesizeAttributes()
protected Map<String,Object>	synthesizeHclAttributes()

Methods inherited from class com.hashicorp.cdktf.TerraformResource

addMoveTarget, getAnyMapAttribute, getBooleanAttribute, getBooleanMapAttribute, getConnection, getCount, getDependsOn, getForEach, getLifecycle, getListAttribute, getNumberAttribute, getNumberListAttribute, getNumberMapAttribute, getProvider, getProvisioners, getStringAttribute, getStringMapAttribute, getTerraformGeneratorMetadata, getTerraformMetaArguments, getTerraformResourceType, hasResourceMove, importFrom, importFrom, interpolationForAttribute, isTerraformResource, moveFromId, moveTo, moveTo, moveToId, setConnection, setConnection, setCount, setCount, setDependsOn, setForEach, setLifecycle, setProvider, setProvisioners, toHclTerraform, toMetadata, toTerraform

Methods inherited from class com.hashicorp.cdktf.TerraformElement

addOverride, getCdktfStack, getConstructNodeMetadata, getFqn, getFriendlyUniqueId, getRawOverrides, isTerraformElement, overrideLogicalId, resetOverrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.hashicorp.cdktf.ITerraformAddressable

getFqn

Methods inherited from interface com.hashicorp.cdktf.ITerraformResource

getFqn, getFriendlyUniqueId

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

TF_RESOURCE_TYPE

@Stability(Experimental)
public static final String TF_RESOURCE_TYPE

Constructor Details

DataResource

protected DataResource(software.amazon.jsii.JsiiObjectRef objRef)

DataResource

protected DataResource(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

DataResource

@Stability(Experimental)
public DataResource(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @Nullable
 DataConfig config)

(experimental) Create a new TerraformData Resource.

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.

Parameters:

scope - The scope in which to define this construct. This parameter is required.

id - The scoped construct ID. This parameter is required.

config -

DataResource

@Stability(Experimental)
public DataResource(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id)

(experimental) Create a new TerraformData Resource.

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.

Parameters:

scope - The scope in which to define this construct. This parameter is required.

id - The scoped construct ID. This parameter is required.

Method Details

generateConfigForImport

@Stability(Experimental)
@NotNull
public static ImportableResource generateConfigForImport(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String importToId,
 @NotNull
 String importFromId,
 @Nullable
 TerraformProvider provider)

(experimental) Generates CDKTF code for importing a Data resource upon running "cdktf plan invalid input: '<'stack-name>".

Parameters:

scope - The scope in which to define this construct. This parameter is required.

importToId - The construct id used in the generated config for the Data to import. This parameter is required.

importFromId - The id of the existing Data that should be imported. This parameter is required.

provider - ? Optional instance of the provider where the Data to import is found.

generateConfigForImport

@Stability(Experimental)
@NotNull
public static ImportableResource generateConfigForImport(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String importToId,
 @NotNull
 String importFromId)

(experimental) Generates CDKTF code for importing a Data resource upon running "cdktf plan invalid input: '<'stack-name>".

Parameters:

scope - The scope in which to define this construct. This parameter is required.

importToId - The construct id used in the generated config for the Data to import. This parameter is required.

importFromId - The id of the existing Data that should be imported. This parameter is required.

resetInput

@Stability(Experimental)
public void resetInput()

resetTriggersReplace

@Stability(Experimental)
public void resetTriggersReplace()

synthesizeAttributes

@Stability(Experimental)
@NotNull
protected Map<String,Object> synthesizeAttributes()

Overrides:

synthesizeAttributes in class TerraformResource

synthesizeHclAttributes

@Stability(Experimental)
@NotNull
protected Map<String,Object> synthesizeHclAttributes()

Overrides:

synthesizeHclAttributes in class TerraformResource

getId

@Stability(Experimental)
@NotNull
public String getId()

getOutput

@Stability(Experimental)
@NotNull
public AnyMap getOutput()

getInputInput

@Stability(Experimental)
@Nullable
public Map<String,Object> getInputInput()

getTriggersReplaceInput

@Stability(Experimental)
@Nullable
public Map<String,Object> getTriggersReplaceInput()

getInput

@Stability(Experimental)
@NotNull
public Map<String,Object> getInput()

(experimental) (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

setInput

@Stability(Experimental)
public void setInput(@NotNull
 Map<String,Object> value)

(experimental) (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

getTriggersReplace

@Stability(Experimental)
@NotNull
public Map<String,Object> getTriggersReplace()

(experimental) (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

setTriggersReplace

@Stability(Experimental)
public void setTriggersReplace(@NotNull
 Map<String,Object> value)

(experimental) (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