`dataDigitaloceanDroplet` Submodule

Constructs

DataDigitaloceanDroplet

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

Initializers

from cdktf_cdktf_provider_digitalocean import data_digitalocean_droplet

dataDigitaloceanDroplet.DataDigitaloceanDroplet(
  scope: Construct,
  id: str,
  connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection] = None,
  count: typing.Union[typing.Union[int, float], TerraformCount] = None,
  depends_on: typing.List[ITerraformDependable] = None,
  for_each: ITerraformIterator = None,
  lifecycle: TerraformResourceLifecycle = None,
  provider: TerraformProvider = None,
  provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]] = None,
  gpu: typing.Union[bool, IResolvable] = None,
  id: typing.Union[int, float] = None,
  name: str = None,
  tag: str = None
)

Name	Type	Description
`scope`	`constructs.Construct`	The scope in which to define this construct.
`id`	`str`	The scoped construct ID.
`connection`	`typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]`	No description.
`count`	`typing.Union[typing.Union[int, float], cdktf.TerraformCount]`	No description.
`depends_on`	`typing.List[cdktf.ITerraformDependable]`	No description.
`for_each`	`cdktf.ITerraformIterator`	No description.
`lifecycle`	`cdktf.TerraformResourceLifecycle`	No description.
`provider`	`cdktf.TerraformProvider`	No description.
`provisioners`	`typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]`	No description.
`gpu`	`typing.Union[bool, cdktf.IResolvable]`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/data-sources/droplet#gpu DataDigitaloceanDroplet#gpu}.
`id`	`typing.Union[int, float]`	id of the Droplet.
`name`	`str`	name of the Droplet.
`tag`	`str`	unique tag of the Droplet.

`scope`^Required

Type: constructs.Construct

The scope in which to define this construct.

`id`^Required

Type: str

The scoped construct ID.

Must be unique amongst siblings in the same scope

`connection`^Optional

Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]

`count`^Optional

Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]

`depends_on`^Optional

Type: typing.List[cdktf.ITerraformDependable]

`for_each`^Optional

Type: cdktf.ITerraformIterator

`lifecycle`^Optional

Type: cdktf.TerraformResourceLifecycle

`provider`^Optional

Type: cdktf.TerraformProvider

`provisioners`^Optional

Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]

`gpu`^Optional

Type: typing.Union[bool, cdktf.IResolvable]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/data-sources/droplet#gpu DataDigitaloceanDroplet#gpu}.

`id`^Optional

Type: typing.Union[int, float]

id of the Droplet.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/data-sources/droplet#id DataDigitaloceanDroplet#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.

`name`^Optional

Type: str

name of the Droplet.

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

`tag`^Optional

Type: str

unique tag of the Droplet.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/data-sources/droplet#tag DataDigitaloceanDroplet#tag}

Methods

Name	Description
`to_string`	Returns a string representation of this construct.
`add_override`	No description.
`override_logical_id`	Overrides the auto-generated logical ID with a specific ID.
`reset_override_logical_id`	Resets a previously passed logical Id to use the auto-generated logical id again.
`to_hcl_terraform`	Adds this resource to the terraform JSON output.
`to_metadata`	No description.
`to_terraform`	Adds this resource to the terraform JSON output.
`get_any_map_attribute`	No description.
`get_boolean_attribute`	No description.
`get_boolean_map_attribute`	No description.
`get_list_attribute`	No description.
`get_number_attribute`	No description.
`get_number_list_attribute`	No description.
`get_number_map_attribute`	No description.
`get_string_attribute`	No description.
`get_string_map_attribute`	No description.
`interpolation_for_attribute`	No description.
`reset_gpu`	No description.
`reset_id`	No description.
`reset_name`	No description.
`reset_tag`	No description.

`to_string`

def to_string() -> str

Returns a string representation of this construct.

`add_override`

def add_override(
  path: str,
  value: typing.Any
) -> None

`path`^Required

Type: str

`value`^Required

Type: typing.Any

`override_logical_id`

def override_logical_id(
  new_logical_id: str
) -> None

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

`new_logical_id`^Required

Type: str

The new logical ID to use for this stack element.

`reset_override_logical_id`

def reset_override_logical_id() -> None

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

`to_hcl_terraform`

def to_hcl_terraform() -> typing.Any

Adds this resource to the terraform JSON output.

`to_metadata`

def to_metadata() -> typing.Any

`to_terraform`

def to_terraform() -> typing.Any

Adds this resource to the terraform JSON output.

`get_any_map_attribute`

def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]

`terraform_attribute`^Required

Type: str

`get_boolean_attribute`

def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable

`terraform_attribute`^Required

Type: str

`get_boolean_map_attribute`

def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]

`terraform_attribute`^Required

Type: str

`get_list_attribute`

def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]

`terraform_attribute`^Required

Type: str

`get_number_attribute`

def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]

`terraform_attribute`^Required

Type: str

`get_number_list_attribute`

def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]

`terraform_attribute`^Required

Type: str

`get_number_map_attribute`

def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]

`terraform_attribute`^Required

Type: str

`get_string_attribute`

def get_string_attribute(
  terraform_attribute: str
) -> str

`terraform_attribute`^Required

Type: str

`get_string_map_attribute`

def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]

`terraform_attribute`^Required

Type: str

`interpolation_for_attribute`

def interpolation_for_attribute(
  terraform_attribute: str
) -> IResolvable

`terraform_attribute`^Required

Type: str

`reset_gpu`

def reset_gpu() -> None

`reset_id`

def reset_id() -> None

`reset_name`

def reset_name() -> None

`reset_tag`

def reset_tag() -> None

Static Functions

Name	Description
`is_construct`	Checks if `x` is a construct.
`is_terraform_element`	No description.
`is_terraform_data_source`	No description.
`generate_config_for_import`	Generates CDKTF code for importing a DataDigitaloceanDroplet resource upon running "cdktf plan ".

`is_construct`

from cdktf_cdktf_provider_digitalocean import data_digitalocean_droplet

dataDigitaloceanDroplet.DataDigitaloceanDroplet.is_construct(
  x: typing.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: typing.Any

Any object.

`is_terraform_element`

from cdktf_cdktf_provider_digitalocean import data_digitalocean_droplet

dataDigitaloceanDroplet.DataDigitaloceanDroplet.is_terraform_element(
  x: typing.Any
)

`x`^Required

Type: typing.Any

`is_terraform_data_source`

from cdktf_cdktf_provider_digitalocean import data_digitalocean_droplet

dataDigitaloceanDroplet.DataDigitaloceanDroplet.is_terraform_data_source(
  x: typing.Any
)

`x`^Required

Type: typing.Any

`generate_config_for_import`

from cdktf_cdktf_provider_digitalocean import data_digitalocean_droplet

dataDigitaloceanDroplet.DataDigitaloceanDroplet.generate_config_for_import(
  scope: Construct,
  import_to_id: str,
  import_from_id: str,
  provider: TerraformProvider = None
)

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

`scope`^Required

Type: constructs.Construct

The scope in which to define this construct.

`import_to_id`^Required

Type: str

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

`import_from_id`^Required

Type: str

The id of the existing DataDigitaloceanDroplet that should be imported.

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

`provider`^Optional

Type: cdktf.TerraformProvider

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

Properties

Name	Type	Description
`node`	`constructs.Node`	The tree node.
`cdktf_stack`	`cdktf.TerraformStack`	No description.
`fqn`	`str`	No description.
`friendly_unique_id`	`str`	No description.
`terraform_meta_arguments`	`typing.Mapping[typing.Any]`	No description.
`terraform_resource_type`	`str`	No description.
`terraform_generator_metadata`	`cdktf.TerraformProviderGeneratorMetadata`	No description.
`count`	`typing.Union[typing.Union[int, float], cdktf.TerraformCount]`	No description.
`depends_on`	`typing.List[str]`	No description.
`for_each`	`cdktf.ITerraformIterator`	No description.
`lifecycle`	`cdktf.TerraformResourceLifecycle`	No description.
`provider`	`cdktf.TerraformProvider`	No description.
`backups`	`cdktf.IResolvable`	No description.
`created_at`	`str`	No description.
`disk`	`typing.Union[int, float]`	No description.
`image`	`str`	No description.
`ipv4_address`	`str`	No description.
`ipv4_address_private`	`str`	No description.
`ipv6`	`cdktf.IResolvable`	No description.
`ipv6_address`	`str`	No description.
`ipv6_address_private`	`str`	No description.
`locked`	`cdktf.IResolvable`	No description.
`memory`	`typing.Union[int, float]`	No description.
`monitoring`	`cdktf.IResolvable`	No description.
`price_hourly`	`typing.Union[int, float]`	No description.
`price_monthly`	`typing.Union[int, float]`	No description.
`private_networking`	`cdktf.IResolvable`	No description.
`region`	`str`	No description.
`size`	`str`	No description.
`status`	`str`	No description.
`tags`	`typing.List[str]`	No description.
`urn`	`str`	No description.
`vcpus`	`typing.Union[int, float]`	No description.
`volume_ids`	`typing.List[str]`	No description.
`vpc_uuid`	`str`	No description.
`gpu_input`	`typing.Union[bool, cdktf.IResolvable]`	No description.
`id_input`	`typing.Union[int, float]`	No description.
`name_input`	`str`	No description.
`tag_input`	`str`	No description.
`gpu`	`typing.Union[bool, cdktf.IResolvable]`	No description.
`id`	`typing.Union[int, float]`	No description.
`name`	`str`	No description.
`tag`	`str`	No description.

`node`^Required

node: Node

Type: constructs.Node

The tree node.

`cdktf_stack`^Required

cdktf_stack: TerraformStack

Type: cdktf.TerraformStack

`fqn`^Required

fqn: str

Type: str

`friendly_unique_id`^Required

friendly_unique_id: str

Type: str

`terraform_meta_arguments`^Required

terraform_meta_arguments: typing.Mapping[typing.Any]

Type: typing.Mapping[typing.Any]

`terraform_resource_type`^Required

terraform_resource_type: str

Type: str

`terraform_generator_metadata`^Optional

terraform_generator_metadata: TerraformProviderGeneratorMetadata

Type: cdktf.TerraformProviderGeneratorMetadata

`count`^Optional

count: typing.Union[typing.Union[int, float], TerraformCount]

Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]

`depends_on`^Optional

depends_on: typing.List[str]

Type: typing.List[str]

`for_each`^Optional

for_each: ITerraformIterator

Type: cdktf.ITerraformIterator

`lifecycle`^Optional

lifecycle: TerraformResourceLifecycle

Type: cdktf.TerraformResourceLifecycle

`provider`^Optional

provider: TerraformProvider

Type: cdktf.TerraformProvider

`backups`^Required

backups: IResolvable

Type: cdktf.IResolvable

`created_at`^Required

created_at: str

Type: str

`disk`^Required

disk: typing.Union[int, float]

Type: typing.Union[int, float]

`image`^Required

image: str

Type: str

`ipv4_address`^Required

ipv4_address: str

Type: str

`ipv4_address_private`^Required

ipv4_address_private: str

Type: str

`ipv6`^Required

ipv6: IResolvable

Type: cdktf.IResolvable

`ipv6_address`^Required

ipv6_address: str

Type: str

`ipv6_address_private`^Required

ipv6_address_private: str

Type: str

`locked`^Required

locked: IResolvable

Type: cdktf.IResolvable

`memory`^Required

memory: typing.Union[int, float]

Type: typing.Union[int, float]

`monitoring`^Required

monitoring: IResolvable

Type: cdktf.IResolvable

`price_hourly`^Required

price_hourly: typing.Union[int, float]

Type: typing.Union[int, float]

`price_monthly`^Required

price_monthly: typing.Union[int, float]

Type: typing.Union[int, float]

`private_networking`^Required

private_networking: IResolvable

Type: cdktf.IResolvable

`region`^Required

region: str

Type: str

`size`^Required

size: str

Type: str

`status`^Required

status: str

Type: str

`tags`^Required

tags: typing.List[str]

Type: typing.List[str]

`urn`^Required

urn: str

Type: str

`vcpus`^Required

vcpus: typing.Union[int, float]

Type: typing.Union[int, float]

`volume_ids`^Required

volume_ids: typing.List[str]

Type: typing.List[str]

`vpc_uuid`^Required

vpc_uuid: str

Type: str

`gpu_input`^Optional

gpu_input: typing.Union[bool, IResolvable]

Type: typing.Union[bool, cdktf.IResolvable]

`id_input`^Optional

id_input: typing.Union[int, float]

Type: typing.Union[int, float]

`name_input`^Optional

name_input: str

Type: str

`tag_input`^Optional

tag_input: str

Type: str

`gpu`^Required

gpu: typing.Union[bool, IResolvable]

Type: typing.Union[bool, cdktf.IResolvable]

`id`^Required

id: typing.Union[int, float]

Type: typing.Union[int, float]

`name`^Required

name: str

Type: str

`tag`^Required

tag: str

Type: str

Constants

Name	Type	Description
`tfResourceType`	`str`	No description.

`tfResourceType`^Required

tfResourceType: str

Type: str

Structs

DataDigitaloceanDropletConfig

Initializer

from cdktf_cdktf_provider_digitalocean import data_digitalocean_droplet

dataDigitaloceanDroplet.DataDigitaloceanDropletConfig(
  connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection] = None,
  count: typing.Union[typing.Union[int, float], TerraformCount] = None,
  depends_on: typing.List[ITerraformDependable] = None,
  for_each: ITerraformIterator = None,
  lifecycle: TerraformResourceLifecycle = None,
  provider: TerraformProvider = None,
  provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]] = None,
  gpu: typing.Union[bool, IResolvable] = None,
  id: typing.Union[int, float] = None,
  name: str = None,
  tag: str = None
)

Properties

Name	Type	Description
`connection`	`typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]`	No description.
`count`	`typing.Union[typing.Union[int, float], cdktf.TerraformCount]`	No description.
`depends_on`	`typing.List[cdktf.ITerraformDependable]`	No description.
`for_each`	`cdktf.ITerraformIterator`	No description.
`lifecycle`	`cdktf.TerraformResourceLifecycle`	No description.
`provider`	`cdktf.TerraformProvider`	No description.
`provisioners`	`typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]`	No description.
`gpu`	`typing.Union[bool, cdktf.IResolvable]`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/data-sources/droplet#gpu DataDigitaloceanDroplet#gpu}.
`id`	`typing.Union[int, float]`	id of the Droplet.
`name`	`str`	name of the Droplet.
`tag`	`str`	unique tag of the Droplet.

`connection`^Optional

connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection]

Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]

`count`^Optional

count: typing.Union[typing.Union[int, float], TerraformCount]

Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]

`depends_on`^Optional

depends_on: typing.List[ITerraformDependable]

Type: typing.List[cdktf.ITerraformDependable]

`for_each`^Optional

for_each: ITerraformIterator

Type: cdktf.ITerraformIterator

`lifecycle`^Optional

lifecycle: TerraformResourceLifecycle

Type: cdktf.TerraformResourceLifecycle

`provider`^Optional

provider: TerraformProvider

Type: cdktf.TerraformProvider

`provisioners`^Optional

provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]]

Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]

`gpu`^Optional

gpu: typing.Union[bool, IResolvable]

Type: typing.Union[bool, cdktf.IResolvable]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/data-sources/droplet#gpu DataDigitaloceanDroplet#gpu}.

`id`^Optional

id: typing.Union[int, float]

Type: typing.Union[int, float]

id of the Droplet.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/data-sources/droplet#id DataDigitaloceanDroplet#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.

`name`^Optional

name: str

Type: str

name of the Droplet.

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

`tag`^Optional

tag: str

Type: str

unique tag of the Droplet.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/data-sources/droplet#tag DataDigitaloceanDroplet#tag}

Files

dataDigitaloceanDroplet.python.md

Latest commit

History

dataDigitaloceanDroplet.python.md

File metadata and controls

dataDigitaloceanDroplet Submodule

Constructs