Skip to content

Latest commit

 

History

History
1078 lines (676 loc) · 44.5 KB

dataDigitaloceanDroplet.csharp.md

File metadata and controls

1078 lines (676 loc) · 44.5 KB

dataDigitaloceanDroplet Submodule

Constructs

DataDigitaloceanDroplet

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

Initializers

using HashiCorp.Cdktf.Providers.Digitalocean;

new DataDigitaloceanDroplet(Construct Scope, string Id, DataDigitaloceanDropletConfig Config = null);
Name Type Description
Scope Constructs.Construct The scope in which to define this construct.
Id string The scoped construct ID.
Config DataDigitaloceanDropletConfig No description.

ScopeRequired
  • Type: Constructs.Construct

The scope in which to define this construct.


IdRequired
  • Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope


ConfigOptional

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.
ResetGpu No description.
ResetId No description.
ResetName No description.
ResetTag No description.

ToString
private string ToString()

Returns a string representation of this construct.

AddOverride
private void AddOverride(string Path, object Value)
PathRequired
  • Type: string

ValueRequired
  • Type: object

OverrideLogicalId
private void OverrideLogicalId(string NewLogicalId)

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

NewLogicalIdRequired
  • Type: string

The new logical ID to use for this stack element.


ResetOverrideLogicalId
private void ResetOverrideLogicalId()

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

ToHclTerraform
private object ToHclTerraform()

Adds this resource to the terraform JSON output.

ToMetadata
private object ToMetadata()
ToTerraform
private object ToTerraform()

Adds this resource to the terraform JSON output.

GetAnyMapAttribute
private System.Collections.Generic.IDictionary<string, object> GetAnyMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetBooleanAttribute
private IResolvable GetBooleanAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetBooleanMapAttribute
private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetListAttribute
private string[] GetListAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetNumberAttribute
private double GetNumberAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetNumberListAttribute
private double[] GetNumberListAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetNumberMapAttribute
private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetStringAttribute
private string GetStringAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetStringMapAttribute
private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

InterpolationForAttribute
private IResolvable InterpolationForAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

ResetGpu
private void ResetGpu()
ResetId
private void ResetId()
ResetName
private void ResetName()
ResetTag
private void ResetTag()

Static Functions

Name Description
IsConstruct Checks if x is a construct.
IsTerraformElement No description.
IsTerraformDataSource No description.
GenerateConfigForImport Generates CDKTF code for importing a DataDigitaloceanDroplet resource upon running "cdktf plan ".

IsConstruct
using HashiCorp.Cdktf.Providers.Digitalocean;

DataDigitaloceanDroplet.IsConstruct(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.

XRequired
  • Type: object

Any object.


IsTerraformElement
using HashiCorp.Cdktf.Providers.Digitalocean;

DataDigitaloceanDroplet.IsTerraformElement(object X);
XRequired
  • Type: object

IsTerraformDataSource
using HashiCorp.Cdktf.Providers.Digitalocean;

DataDigitaloceanDroplet.IsTerraformDataSource(object X);
XRequired
  • Type: object

GenerateConfigForImport
using HashiCorp.Cdktf.Providers.Digitalocean;

DataDigitaloceanDroplet.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null);

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

ScopeRequired
  • Type: Constructs.Construct

The scope in which to define this construct.


ImportToIdRequired
  • Type: string

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


ImportFromIdRequired
  • Type: string

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


ProviderOptional
  • Type: HashiCorp.Cdktf.TerraformProvider

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


Properties

Name Type Description
Node Constructs.Node The tree node.
CdktfStack HashiCorp.Cdktf.TerraformStack No description.
Fqn string No description.
FriendlyUniqueId string No description.
TerraformMetaArguments System.Collections.Generic.IDictionary<string, object> No description.
TerraformResourceType string No description.
TerraformGeneratorMetadata HashiCorp.Cdktf.TerraformProviderGeneratorMetadata No description.
Count object No description.
DependsOn string[] No description.
ForEach HashiCorp.Cdktf.ITerraformIterator No description.
Lifecycle HashiCorp.Cdktf.TerraformResourceLifecycle No description.
Provider HashiCorp.Cdktf.TerraformProvider No description.
Backups HashiCorp.Cdktf.IResolvable No description.
CreatedAt string No description.
Disk double No description.
Image string No description.
Ipv4Address string No description.
Ipv4AddressPrivate string No description.
Ipv6 HashiCorp.Cdktf.IResolvable No description.
Ipv6Address string No description.
Ipv6AddressPrivate string No description.
Locked HashiCorp.Cdktf.IResolvable No description.
Memory double No description.
Monitoring HashiCorp.Cdktf.IResolvable No description.
PriceHourly double No description.
PriceMonthly double No description.
PrivateNetworking HashiCorp.Cdktf.IResolvable No description.
Region string No description.
Size string No description.
Status string No description.
Tags string[] No description.
Urn string No description.
Vcpus double No description.
VolumeIds string[] No description.
VpcUuid string No description.
GpuInput object No description.
IdInput double No description.
NameInput string No description.
TagInput string No description.
Gpu object No description.
Id double No description.
Name string No description.
Tag string No description.

NodeRequired
public Node Node { get; }
  • Type: Constructs.Node

The tree node.


CdktfStackRequired
public TerraformStack CdktfStack { get; }
  • Type: HashiCorp.Cdktf.TerraformStack

FqnRequired
public string Fqn { get; }
  • Type: string

FriendlyUniqueIdRequired
public string FriendlyUniqueId { get; }
  • Type: string

TerraformMetaArgumentsRequired
public System.Collections.Generic.IDictionary<string, object> TerraformMetaArguments { get; }
  • Type: System.Collections.Generic.IDictionary<string, object>

TerraformResourceTypeRequired
public string TerraformResourceType { get; }
  • Type: string

TerraformGeneratorMetadataOptional
public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; }
  • Type: HashiCorp.Cdktf.TerraformProviderGeneratorMetadata

CountOptional
public object Count { get; }
  • Type: object

DependsOnOptional
public string[] DependsOn { get; }
  • Type: string[]

ForEachOptional
public ITerraformIterator ForEach { get; }
  • Type: HashiCorp.Cdktf.ITerraformIterator

LifecycleOptional
public TerraformResourceLifecycle Lifecycle { get; }
  • Type: HashiCorp.Cdktf.TerraformResourceLifecycle

ProviderOptional
public TerraformProvider Provider { get; }
  • Type: HashiCorp.Cdktf.TerraformProvider

BackupsRequired
public IResolvable Backups { get; }
  • Type: HashiCorp.Cdktf.IResolvable

CreatedAtRequired
public string CreatedAt { get; }
  • Type: string

DiskRequired
public double Disk { get; }
  • Type: double

ImageRequired
public string Image { get; }
  • Type: string

Ipv4AddressRequired
public string Ipv4Address { get; }
  • Type: string

Ipv4AddressPrivateRequired
public string Ipv4AddressPrivate { get; }
  • Type: string

Ipv6Required
public IResolvable Ipv6 { get; }
  • Type: HashiCorp.Cdktf.IResolvable

Ipv6AddressRequired
public string Ipv6Address { get; }
  • Type: string

Ipv6AddressPrivateRequired
public string Ipv6AddressPrivate { get; }
  • Type: string

LockedRequired
public IResolvable Locked { get; }
  • Type: HashiCorp.Cdktf.IResolvable

MemoryRequired
public double Memory { get; }
  • Type: double

MonitoringRequired
public IResolvable Monitoring { get; }
  • Type: HashiCorp.Cdktf.IResolvable

PriceHourlyRequired
public double PriceHourly { get; }
  • Type: double

PriceMonthlyRequired
public double PriceMonthly { get; }
  • Type: double

PrivateNetworkingRequired
public IResolvable PrivateNetworking { get; }
  • Type: HashiCorp.Cdktf.IResolvable

RegionRequired
public string Region { get; }
  • Type: string

SizeRequired
public string Size { get; }
  • Type: string

StatusRequired
public string Status { get; }
  • Type: string

TagsRequired
public string[] Tags { get; }
  • Type: string[]

UrnRequired
public string Urn { get; }
  • Type: string

VcpusRequired
public double Vcpus { get; }
  • Type: double

VolumeIdsRequired
public string[] VolumeIds { get; }
  • Type: string[]

VpcUuidRequired
public string VpcUuid { get; }
  • Type: string

GpuInputOptional
public object GpuInput { get; }
  • Type: object

IdInputOptional
public double IdInput { get; }
  • Type: double

NameInputOptional
public string NameInput { get; }
  • Type: string

TagInputOptional
public string TagInput { get; }
  • Type: string

GpuRequired
public object Gpu { get; }
  • Type: object

IdRequired
public double Id { get; }
  • Type: double

NameRequired
public string Name { get; }
  • Type: string

TagRequired
public string Tag { get; }
  • Type: string

Constants

Name Type Description
TfResourceType string No description.

TfResourceTypeRequired
public string TfResourceType { get; }
  • Type: string

Structs

DataDigitaloceanDropletConfig

Initializer

using HashiCorp.Cdktf.Providers.Digitalocean;

new DataDigitaloceanDropletConfig {
    object Connection = null,
    object Count = null,
    ITerraformDependable[] DependsOn = null,
    ITerraformIterator ForEach = null,
    TerraformResourceLifecycle Lifecycle = null,
    TerraformProvider Provider = null,
    object[] Provisioners = null,
    object Gpu = null,
    double Id = null,
    string Name = null,
    string Tag = null
};

Properties

Name Type Description
Connection object No description.
Count object No description.
DependsOn HashiCorp.Cdktf.ITerraformDependable[] No description.
ForEach HashiCorp.Cdktf.ITerraformIterator No description.
Lifecycle HashiCorp.Cdktf.TerraformResourceLifecycle No description.
Provider HashiCorp.Cdktf.TerraformProvider No description.
Provisioners object[] No description.
Gpu object Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/data-sources/droplet#gpu DataDigitaloceanDroplet#gpu}.
Id double id of the Droplet.
Name string name of the Droplet.
Tag string unique tag of the Droplet.

ConnectionOptional
public object Connection { get; set; }
  • Type: object

CountOptional
public object Count { get; set; }
  • Type: object

DependsOnOptional
public ITerraformDependable[] DependsOn { get; set; }
  • Type: HashiCorp.Cdktf.ITerraformDependable[]

ForEachOptional
public ITerraformIterator ForEach { get; set; }
  • Type: HashiCorp.Cdktf.ITerraformIterator

LifecycleOptional
public TerraformResourceLifecycle Lifecycle { get; set; }
  • Type: HashiCorp.Cdktf.TerraformResourceLifecycle

ProviderOptional
public TerraformProvider Provider { get; set; }
  • Type: HashiCorp.Cdktf.TerraformProvider

ProvisionersOptional
public object[] Provisioners { get; set; }
  • Type: object[]

GpuOptional
public object Gpu { get; set; }
  • Type: object

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


IdOptional
public double Id { get; set; }
  • Type: double

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.


NameOptional
public string Name { get; set; }
  • Type: string

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}


TagOptional
public string Tag { get; set; }
  • Type: string

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}