`dataLocalCommand` Submodule

Constructs

DataLocalCommand

Represents a {@link https://registry.terraform.io/providers/hashicorp/local/2.6.1/docs/data-sources/command local_command}.

Initializers

import com.hashicorp.cdktf.providers.local.data_local_command.DataLocalCommand;

DataLocalCommand.Builder.create(Construct scope, java.lang.String id)
//  .connection(SSHProvisionerConnection|WinrmProvisionerConnection)
//  .count(java.lang.Number|TerraformCount)
//  .dependsOn(java.util.List<ITerraformDependable>)
//  .forEach(ITerraformIterator)
//  .lifecycle(TerraformResourceLifecycle)
//  .provider(TerraformProvider)
//  .provisioners(java.util.List<FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner>)
    .command(java.lang.String)
//  .allowNonZeroExitCode(java.lang.Boolean|IResolvable)
//  .arguments(java.util.List<java.lang.String>)
//  .stdin(java.lang.String)
//  .workingDirectory(java.lang.String)
    .build();

Name	Type	Description
`scope`	`software.constructs.Construct`	The scope in which to define this construct.
`id`	`java.lang.String`	The scoped construct ID.
`connection`	`com.hashicorp.cdktf.SSHProvisionerConnection\|com.hashicorp.cdktf.WinrmProvisionerConnection`	No description.
`count`	`java.lang.Number\|com.hashicorp.cdktf.TerraformCount`	No description.
`dependsOn`	`java.util.List<com.hashicorp.cdktf.ITerraformDependable>`	No description.
`forEach`	`com.hashicorp.cdktf.ITerraformIterator`	No description.
`lifecycle`	`com.hashicorp.cdktf.TerraformResourceLifecycle`	No description.
`provider`	`com.hashicorp.cdktf.TerraformProvider`	No description.
`provisioners`	`java.util.List<com.hashicorp.cdktf.FileProvisioner\|com.hashicorp.cdktf.LocalExecProvisioner\|com.hashicorp.cdktf.RemoteExecProvisioner>`	No description.
`command`	`java.lang.String`	Executable name to be discovered on the PATH or absolute path to executable.
`allowNonZeroExitCode`	`java.lang.Boolean\|com.hashicorp.cdktf.IResolvable`	Indicates that the command returning a non-zero exit code should be treated as a successful execution.
`arguments`	`java.util.List<java.lang.String>`	Arguments to be passed to the given command. Any `null` arguments will be removed from the list.
`stdin`	`java.lang.String`	Data to be passed to the given command's standard input as a UTF-8 string.
`workingDirectory`	`java.lang.String`	The directory path where the command should be executed, either an absolute path or relative to the Terraform working directory.

`scope`^Required

Type: software.constructs.Construct

The scope in which to define this construct.

`id`^Required

Type: java.lang.String

The scoped construct ID.

Must be unique amongst siblings in the same scope

`connection`^Optional

Type: com.hashicorp.cdktf.SSHProvisionerConnection|com.hashicorp.cdktf.WinrmProvisionerConnection

`count`^Optional

Type: java.lang.Number|com.hashicorp.cdktf.TerraformCount

`dependsOn`^Optional

Type: java.util.List<com.hashicorp.cdktf.ITerraformDependable>

`forEach`^Optional

Type: com.hashicorp.cdktf.ITerraformIterator

`lifecycle`^Optional

Type: com.hashicorp.cdktf.TerraformResourceLifecycle

`provider`^Optional

Type: com.hashicorp.cdktf.TerraformProvider

`provisioners`^Optional

Type: java.util.List<com.hashicorp.cdktf.FileProvisioner|com.hashicorp.cdktf.LocalExecProvisioner|com.hashicorp.cdktf.RemoteExecProvisioner>

`command`^Required

Type: java.lang.String

Executable name to be discovered on the PATH or absolute path to executable.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/local/2.6.1/docs/data-sources/command#command DataLocalCommand#command}

`allowNonZeroExitCode`^Optional

Type: java.lang.Boolean|com.hashicorp.cdktf.IResolvable

Indicates that the command returning a non-zero exit code should be treated as a successful execution.

Further assertions can be made of the exit_code value with the check block. Defaults to false.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/local/2.6.1/docs/data-sources/command#allow_non_zero_exit_code DataLocalCommand#allow_non_zero_exit_code}

`arguments`^Optional

Type: java.util.List<java.lang.String>

Arguments to be passed to the given command. Any null arguments will be removed from the list.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/local/2.6.1/docs/data-sources/command#arguments DataLocalCommand#arguments}

`stdin`^Optional

Type: java.lang.String

Data to be passed to the given command's standard input as a UTF-8 string.

Terraform values can be encoded by any Terraform encode function, for example, jsonencode.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/local/2.6.1/docs/data-sources/command#stdin DataLocalCommand#stdin}

`workingDirectory`^Optional

Type: java.lang.String

The directory path where the command should be executed, either an absolute path or relative to the Terraform working directory.

If not provided, defaults to the Terraform working directory.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/local/2.6.1/docs/data-sources/command#working_directory DataLocalCommand#working_directory}

Methods

Name	Description
`toString`	Returns a string representation of 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`	Adds this resource to the terraform JSON output.
`toMetadata`	No description.
`toTerraform`	Adds this resource to the terraform JSON output.
`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.
`interpolationForAttribute`	No description.
`resetAllowNonZeroExitCode`	No description.
`resetArguments`	No description.
`resetStdin`	No description.
`resetWorkingDirectory`	No description.

`toString`

public java.lang.String toString()

Returns a string representation of this construct.

`addOverride`

public void addOverride(java.lang.String path, java.lang.Object value)

`path`^Required

Type: java.lang.String

`value`^Required

Type: java.lang.Object

`overrideLogicalId`

public void overrideLogicalId(java.lang.String newLogicalId)

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

`newLogicalId`^Required

Type: java.lang.String

The new logical ID to use for this stack element.

`resetOverrideLogicalId`

public void resetOverrideLogicalId()

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

`toHclTerraform`

public java.lang.Object toHclTerraform()

Adds this resource to the terraform JSON output.

`toMetadata`

public java.lang.Object toMetadata()

`toTerraform`

public java.lang.Object toTerraform()

Adds this resource to the terraform JSON output.

`getAnyMapAttribute`

public java.util.Map<java.lang.String, java.lang.Object> getAnyMapAttribute(java.lang.String terraformAttribute)

`terraformAttribute`^Required

Type: java.lang.String

`getBooleanAttribute`

public IResolvable getBooleanAttribute(java.lang.String terraformAttribute)

`terraformAttribute`^Required

Type: java.lang.String

`getBooleanMapAttribute`

public java.util.Map<java.lang.String, java.lang.Boolean> getBooleanMapAttribute(java.lang.String terraformAttribute)

`terraformAttribute`^Required

Type: java.lang.String

`getListAttribute`

public java.util.List<java.lang.String> getListAttribute(java.lang.String terraformAttribute)

`terraformAttribute`^Required

Type: java.lang.String

`getNumberAttribute`

public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute)

`terraformAttribute`^Required

Type: java.lang.String

`getNumberListAttribute`

public java.util.List<java.lang.Number> getNumberListAttribute(java.lang.String terraformAttribute)

`terraformAttribute`^Required

Type: java.lang.String

`getNumberMapAttribute`

public java.util.Map<java.lang.String, java.lang.Number> getNumberMapAttribute(java.lang.String terraformAttribute)

`terraformAttribute`^Required

Type: java.lang.String

`getStringAttribute`

public java.lang.String getStringAttribute(java.lang.String terraformAttribute)

`terraformAttribute`^Required

Type: java.lang.String

`getStringMapAttribute`

public java.util.Map<java.lang.String, java.lang.String> getStringMapAttribute(java.lang.String terraformAttribute)

`terraformAttribute`^Required

Type: java.lang.String

`interpolationForAttribute`

public IResolvable interpolationForAttribute(java.lang.String terraformAttribute)

`terraformAttribute`^Required

Type: java.lang.String

`resetAllowNonZeroExitCode`

public void resetAllowNonZeroExitCode()

`resetArguments`

public void resetArguments()

`resetStdin`

public void resetStdin()

`resetWorkingDirectory`

public void resetWorkingDirectory()

Static Functions

Name	Description
`isConstruct`	Checks if `x` is a construct.
`isTerraformElement`	No description.
`isTerraformDataSource`	No description.
`generateConfigForImport`	Generates CDKTF code for importing a DataLocalCommand resource upon running "cdktf plan ".

`isConstruct`

import com.hashicorp.cdktf.providers.local.data_local_command.DataLocalCommand;

DataLocalCommand.isConstruct(java.lang.Object x)

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: java.lang.Object

Any object.

`isTerraformElement`

import com.hashicorp.cdktf.providers.local.data_local_command.DataLocalCommand;

DataLocalCommand.isTerraformElement(java.lang.Object x)

`x`^Required

Type: java.lang.Object

`isTerraformDataSource`

import com.hashicorp.cdktf.providers.local.data_local_command.DataLocalCommand;

DataLocalCommand.isTerraformDataSource(java.lang.Object x)

`x`^Required

Type: java.lang.Object

`generateConfigForImport`

import com.hashicorp.cdktf.providers.local.data_local_command.DataLocalCommand;

DataLocalCommand.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),DataLocalCommand.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider)

Generates CDKTF code for importing a DataLocalCommand resource upon running "cdktf plan ".

`scope`^Required

Type: software.constructs.Construct

The scope in which to define this construct.

`importToId`^Required

Type: java.lang.String

The construct id used in the generated config for the DataLocalCommand to import.

`importFromId`^Required

Type: java.lang.String

The id of the existing DataLocalCommand that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/local/2.6.1/docs/data-sources/command#import import section} in the documentation of this resource for the id to use

`provider`^Optional

Type: com.hashicorp.cdktf.TerraformProvider

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

Properties

Name	Type	Description
`node`	`software.constructs.Node`	The tree node.
`cdktfStack`	`com.hashicorp.cdktf.TerraformStack`	No description.
`fqn`	`java.lang.String`	No description.
`friendlyUniqueId`	`java.lang.String`	No description.
`terraformMetaArguments`	`java.util.Map<java.lang.String, java.lang.Object>`	No description.
`terraformResourceType`	`java.lang.String`	No description.
`terraformGeneratorMetadata`	`com.hashicorp.cdktf.TerraformProviderGeneratorMetadata`	No description.
`count`	`java.lang.Number\|com.hashicorp.cdktf.TerraformCount`	No description.
`dependsOn`	`java.util.List<java.lang.String>`	No description.
`forEach`	`com.hashicorp.cdktf.ITerraformIterator`	No description.
`lifecycle`	`com.hashicorp.cdktf.TerraformResourceLifecycle`	No description.
`provider`	`com.hashicorp.cdktf.TerraformProvider`	No description.
`exitCode`	`java.lang.Number`	No description.
`stderr`	`java.lang.String`	No description.
`stdout`	`java.lang.String`	No description.
`allowNonZeroExitCodeInput`	`java.lang.Boolean\|com.hashicorp.cdktf.IResolvable`	No description.
`argumentsInput`	`java.util.List<java.lang.String>`	No description.
`commandInput`	`java.lang.String`	No description.
`stdinInput`	`java.lang.String`	No description.
`workingDirectoryInput`	`java.lang.String`	No description.
`allowNonZeroExitCode`	`java.lang.Boolean\|com.hashicorp.cdktf.IResolvable`	No description.
`arguments`	`java.util.List<java.lang.String>`	No description.
`command`	`java.lang.String`	No description.
`stdin`	`java.lang.String`	No description.
`workingDirectory`	`java.lang.String`	No description.

`node`^Required

public Node getNode();

Type: software.constructs.Node

The tree node.

`cdktfStack`^Required

public TerraformStack getCdktfStack();

Type: com.hashicorp.cdktf.TerraformStack

`fqn`^Required

public java.lang.String getFqn();

Type: java.lang.String

`friendlyUniqueId`^Required

public java.lang.String getFriendlyUniqueId();

Type: java.lang.String

`terraformMetaArguments`^Required

public java.util.Map<java.lang.String, java.lang.Object> getTerraformMetaArguments();

Type: java.util.Map<java.lang.String, java.lang.Object>

`terraformResourceType`^Required

public java.lang.String getTerraformResourceType();

Type: java.lang.String

`terraformGeneratorMetadata`^Optional

public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata();

Type: com.hashicorp.cdktf.TerraformProviderGeneratorMetadata

`count`^Optional

public java.lang.Number|TerraformCount getCount();

Type: java.lang.Number|com.hashicorp.cdktf.TerraformCount

`dependsOn`^Optional

public java.util.List<java.lang.String> getDependsOn();

Type: java.util.List<java.lang.String>

`forEach`^Optional

public ITerraformIterator getForEach();

Type: com.hashicorp.cdktf.ITerraformIterator

`lifecycle`^Optional

public TerraformResourceLifecycle getLifecycle();

Type: com.hashicorp.cdktf.TerraformResourceLifecycle

`provider`^Optional

public TerraformProvider getProvider();

Type: com.hashicorp.cdktf.TerraformProvider

`exitCode`^Required

public java.lang.Number getExitCode();

Type: java.lang.Number

`stderr`^Required

public java.lang.String getStderr();

Type: java.lang.String

`stdout`^Required

public java.lang.String getStdout();

Type: java.lang.String

`allowNonZeroExitCodeInput`^Optional

public java.lang.Boolean|IResolvable getAllowNonZeroExitCodeInput();

Type: java.lang.Boolean|com.hashicorp.cdktf.IResolvable

`argumentsInput`^Optional

public java.util.List<java.lang.String> getArgumentsInput();

Type: java.util.List<java.lang.String>

`commandInput`^Optional

public java.lang.String getCommandInput();

Type: java.lang.String

`stdinInput`^Optional

public java.lang.String getStdinInput();

Type: java.lang.String

`workingDirectoryInput`^Optional

public java.lang.String getWorkingDirectoryInput();

Type: java.lang.String

`allowNonZeroExitCode`^Required

public java.lang.Boolean|IResolvable getAllowNonZeroExitCode();

Type: java.lang.Boolean|com.hashicorp.cdktf.IResolvable

`arguments`^Required

public java.util.List<java.lang.String> getArguments();

Type: java.util.List<java.lang.String>

`command`^Required

public java.lang.String getCommand();

Type: java.lang.String

`stdin`^Required

public java.lang.String getStdin();

Type: java.lang.String

`workingDirectory`^Required

public java.lang.String getWorkingDirectory();

Type: java.lang.String

Constants

Name	Type	Description
`tfResourceType`	`java.lang.String`	No description.

`tfResourceType`^Required

public java.lang.String getTfResourceType();

Type: java.lang.String

Structs

DataLocalCommandConfig

Initializer

import com.hashicorp.cdktf.providers.local.data_local_command.DataLocalCommandConfig;

DataLocalCommandConfig.builder()
//  .connection(SSHProvisionerConnection|WinrmProvisionerConnection)
//  .count(java.lang.Number|TerraformCount)
//  .dependsOn(java.util.List<ITerraformDependable>)
//  .forEach(ITerraformIterator)
//  .lifecycle(TerraformResourceLifecycle)
//  .provider(TerraformProvider)
//  .provisioners(java.util.List<FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner>)
    .command(java.lang.String)
//  .allowNonZeroExitCode(java.lang.Boolean|IResolvable)
//  .arguments(java.util.List<java.lang.String>)
//  .stdin(java.lang.String)
//  .workingDirectory(java.lang.String)
    .build();

Properties

Name	Type	Description
`connection`	`com.hashicorp.cdktf.SSHProvisionerConnection\|com.hashicorp.cdktf.WinrmProvisionerConnection`	No description.
`count`	`java.lang.Number\|com.hashicorp.cdktf.TerraformCount`	No description.
`dependsOn`	`java.util.List<com.hashicorp.cdktf.ITerraformDependable>`	No description.
`forEach`	`com.hashicorp.cdktf.ITerraformIterator`	No description.
`lifecycle`	`com.hashicorp.cdktf.TerraformResourceLifecycle`	No description.
`provider`	`com.hashicorp.cdktf.TerraformProvider`	No description.
`provisioners`	`java.util.List<com.hashicorp.cdktf.FileProvisioner\|com.hashicorp.cdktf.LocalExecProvisioner\|com.hashicorp.cdktf.RemoteExecProvisioner>`	No description.
`command`	`java.lang.String`	Executable name to be discovered on the PATH or absolute path to executable.
`allowNonZeroExitCode`	`java.lang.Boolean\|com.hashicorp.cdktf.IResolvable`	Indicates that the command returning a non-zero exit code should be treated as a successful execution.
`arguments`	`java.util.List<java.lang.String>`	Arguments to be passed to the given command. Any `null` arguments will be removed from the list.
`stdin`	`java.lang.String`	Data to be passed to the given command's standard input as a UTF-8 string.
`workingDirectory`	`java.lang.String`	The directory path where the command should be executed, either an absolute path or relative to the Terraform working directory.

`connection`^Optional

public SSHProvisionerConnection|WinrmProvisionerConnection getConnection();

Type: com.hashicorp.cdktf.SSHProvisionerConnection|com.hashicorp.cdktf.WinrmProvisionerConnection

`count`^Optional

public java.lang.Number|TerraformCount getCount();

Type: java.lang.Number|com.hashicorp.cdktf.TerraformCount

`dependsOn`^Optional

public java.util.List<ITerraformDependable> getDependsOn();

Type: java.util.List<com.hashicorp.cdktf.ITerraformDependable>

`forEach`^Optional

public ITerraformIterator getForEach();

Type: com.hashicorp.cdktf.ITerraformIterator

`lifecycle`^Optional

public TerraformResourceLifecycle getLifecycle();

Type: com.hashicorp.cdktf.TerraformResourceLifecycle

`provider`^Optional

public TerraformProvider getProvider();

Type: com.hashicorp.cdktf.TerraformProvider

`provisioners`^Optional

public java.util.List<FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner> getProvisioners();

Type: java.util.List<com.hashicorp.cdktf.FileProvisioner|com.hashicorp.cdktf.LocalExecProvisioner|com.hashicorp.cdktf.RemoteExecProvisioner>

`command`^Required

public java.lang.String getCommand();

Type: java.lang.String

Executable name to be discovered on the PATH or absolute path to executable.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/local/2.6.1/docs/data-sources/command#command DataLocalCommand#command}

`allowNonZeroExitCode`^Optional

public java.lang.Boolean|IResolvable getAllowNonZeroExitCode();

Type: java.lang.Boolean|com.hashicorp.cdktf.IResolvable

Indicates that the command returning a non-zero exit code should be treated as a successful execution.

Further assertions can be made of the exit_code value with the check block. Defaults to false.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/local/2.6.1/docs/data-sources/command#allow_non_zero_exit_code DataLocalCommand#allow_non_zero_exit_code}

`arguments`^Optional

public java.util.List<java.lang.String> getArguments();

Type: java.util.List<java.lang.String>

Arguments to be passed to the given command. Any null arguments will be removed from the list.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/local/2.6.1/docs/data-sources/command#arguments DataLocalCommand#arguments}

`stdin`^Optional

public java.lang.String getStdin();

Type: java.lang.String

Data to be passed to the given command's standard input as a UTF-8 string.

Terraform values can be encoded by any Terraform encode function, for example, jsonencode.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/local/2.6.1/docs/data-sources/command#stdin DataLocalCommand#stdin}

`workingDirectory`^Optional

public java.lang.String getWorkingDirectory();

Type: java.lang.String

The directory path where the command should be executed, either an absolute path or relative to the Terraform working directory.

If not provided, defaults to the Terraform working directory.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/local/2.6.1/docs/data-sources/command#working_directory DataLocalCommand#working_directory}

FilesExpand file tree

dataLocalCommand.java.md

Latest commit

History

dataLocalCommand.java.md

File metadata and controls

dataLocalCommand Submodule

Constructs