`dataDigitaloceanVolume` Submodule

Constructs

DataDigitaloceanVolume

Represents a {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/data-sources/volume digitalocean_volume}.

Initializers

import com.hashicorp.cdktf.providers.digitalocean.data_digitalocean_volume.DataDigitaloceanVolume;

DataDigitaloceanVolume.Builder.create(Construct scope, java.lang.String id)
//  .connection(SSHProvisionerConnection)
//  .connection(WinrmProvisionerConnection)
//  .count(java.lang.Number)
//  .count(TerraformCount)
//  .dependsOn(java.util.List<ITerraformDependable>)
//  .forEach(ITerraformIterator)
//  .lifecycle(TerraformResourceLifecycle)
//  .provider(TerraformProvider)
//  .provisioners(java.util.List<FileProvisioner)
//  .provisioners(LocalExecProvisioner)
//  .provisioners(RemoteExecProvisioner>)
    .name(java.lang.String)
//  .description(java.lang.String)
//  .id(java.lang.String)
//  .region(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 OR com.hashicorp.cdktf.WinrmProvisionerConnection`	No description.
`count`	`java.lang.Number OR 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 OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>`	No description.
`name`	`java.lang.String`	name of the volume.
`description`	`java.lang.String`	volume description.
`id`	`java.lang.String`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/data-sources/volume#id DataDigitaloceanVolume#id}.
`region`	`java.lang.String`	the region that the volume is provisioned in.

`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 OR com.hashicorp.cdktf.WinrmProvisionerConnection

`count`^Optional

Type: java.lang.Number OR 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 OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>

`name`^Required

Type: java.lang.String

name of the volume.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/data-sources/volume#name DataDigitaloceanVolume#name}

`description`^Optional

Type: java.lang.String

volume description.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/data-sources/volume#description DataDigitaloceanVolume#description}

`id`^Optional

Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/data-sources/volume#id DataDigitaloceanVolume#id}.

Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.

`region`^Optional

Type: java.lang.String

the region that the volume is provisioned in.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/data-sources/volume#region DataDigitaloceanVolume#region}

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.
`resetDescription`	No description.
`resetId`	No description.
`resetRegion`	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

`resetDescription`

public void resetDescription()

`resetId`

public void resetId()

`resetRegion`

public void resetRegion()

Static Functions

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

`isConstruct`

import com.hashicorp.cdktf.providers.digitalocean.data_digitalocean_volume.DataDigitaloceanVolume;

DataDigitaloceanVolume.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.digitalocean.data_digitalocean_volume.DataDigitaloceanVolume;

DataDigitaloceanVolume.isTerraformElement(java.lang.Object x)

`x`^Required

Type: java.lang.Object

`isTerraformDataSource`

import com.hashicorp.cdktf.providers.digitalocean.data_digitalocean_volume.DataDigitaloceanVolume;

DataDigitaloceanVolume.isTerraformDataSource(java.lang.Object x)

`x`^Required

Type: java.lang.Object

`generateConfigForImport`

import com.hashicorp.cdktf.providers.digitalocean.data_digitalocean_volume.DataDigitaloceanVolume;

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

Generates CDKTF code for importing a DataDigitaloceanVolume 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 DataDigitaloceanVolume to import.

`importFromId`^Required

Type: java.lang.String

The id of the existing DataDigitaloceanVolume that should be imported.

Refer to the {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/data-sources/volume#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 DataDigitaloceanVolume 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 OR 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.
`dropletIds`	`java.util.List<java.lang.Number>`	No description.
`filesystemLabel`	`java.lang.String`	No description.
`filesystemType`	`java.lang.String`	No description.
`size`	`java.lang.Number`	No description.
`tags`	`java.util.List<java.lang.String>`	No description.
`urn`	`java.lang.String`	No description.
`descriptionInput`	`java.lang.String`	No description.
`idInput`	`java.lang.String`	No description.
`nameInput`	`java.lang.String`	No description.
`regionInput`	`java.lang.String`	No description.
`description`	`java.lang.String`	No description.
`id`	`java.lang.String`	No description.
`name`	`java.lang.String`	No description.
`region`	`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.Object getCount();

Type: java.lang.Number OR 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

`dropletIds`^Required

public java.util.List<java.lang.Number> getDropletIds();

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

`filesystemLabel`^Required

public java.lang.String getFilesystemLabel();

Type: java.lang.String

`filesystemType`^Required

public java.lang.String getFilesystemType();

Type: java.lang.String

`size`^Required

public java.lang.Number getSize();

Type: java.lang.Number

`tags`^Required

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

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

`urn`^Required

public java.lang.String getUrn();

Type: java.lang.String

`descriptionInput`^Optional

public java.lang.String getDescriptionInput();

Type: java.lang.String

`idInput`^Optional

public java.lang.String getIdInput();

Type: java.lang.String

`nameInput`^Optional

public java.lang.String getNameInput();

Type: java.lang.String

`regionInput`^Optional

public java.lang.String getRegionInput();

Type: java.lang.String

`description`^Required

public java.lang.String getDescription();

Type: java.lang.String

`id`^Required

public java.lang.String getId();

Type: java.lang.String

`name`^Required

public java.lang.String getName();

Type: java.lang.String

`region`^Required

public java.lang.String getRegion();

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

DataDigitaloceanVolumeConfig

Initializer

import com.hashicorp.cdktf.providers.digitalocean.data_digitalocean_volume.DataDigitaloceanVolumeConfig;

DataDigitaloceanVolumeConfig.builder()
//  .connection(SSHProvisionerConnection)
//  .connection(WinrmProvisionerConnection)
//  .count(java.lang.Number)
//  .count(TerraformCount)
//  .dependsOn(java.util.List<ITerraformDependable>)
//  .forEach(ITerraformIterator)
//  .lifecycle(TerraformResourceLifecycle)
//  .provider(TerraformProvider)
//  .provisioners(java.util.List<FileProvisioner)
//  .provisioners(LocalExecProvisioner)
//  .provisioners(RemoteExecProvisioner>)
    .name(java.lang.String)
//  .description(java.lang.String)
//  .id(java.lang.String)
//  .region(java.lang.String)
    .build();

Properties

Name	Type	Description
`connection`	`com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection`	No description.
`count`	`java.lang.Number OR 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 OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>`	No description.
`name`	`java.lang.String`	name of the volume.
`description`	`java.lang.String`	volume description.
`id`	`java.lang.String`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/data-sources/volume#id DataDigitaloceanVolume#id}.
`region`	`java.lang.String`	the region that the volume is provisioned in.

`connection`^Optional

public java.lang.Object getConnection();

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

`count`^Optional

public java.lang.Object getCount();

Type: java.lang.Number OR 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.lang.Object getProvisioners();

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

`name`^Required

public java.lang.String getName();

Type: java.lang.String

name of the volume.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/data-sources/volume#name DataDigitaloceanVolume#name}

`description`^Optional

public java.lang.String getDescription();

Type: java.lang.String

volume description.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/data-sources/volume#description DataDigitaloceanVolume#description}

`id`^Optional

public java.lang.String getId();

Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/data-sources/volume#id DataDigitaloceanVolume#id}.

Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.

`region`^Optional

public java.lang.String getRegion();

Type: java.lang.String

the region that the volume is provisioned in.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/data-sources/volume#region DataDigitaloceanVolume#region}

Files

dataDigitaloceanVolume.java.md

Latest commit

History

dataDigitaloceanVolume.java.md

File metadata and controls

dataDigitaloceanVolume Submodule

Constructs