Skip to content

Latest commit

 

History

History
1078 lines (676 loc) · 45 KB

dataDigitaloceanDroplet.go.md

File metadata and controls

1078 lines (676 loc) · 45 KB
Raw

dataDigitaloceanDroplet Submodule

Constructs

DataDigitaloceanDroplet

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

Initializers 

import "github.com/cdktf/cdktf-provider-digitalocean-go/digitalocean/v11/datadigitaloceandroplet"

datadigitaloceandroplet.NewDataDigitaloceanDroplet(scope Construct, id *string, config DataDigitaloceanDropletConfig) DataDigitaloceanDroplet
Name Type Description
scope github.com/aws/constructs-go/constructs/v10.Construct The scope in which to define this construct.
id *string The scoped construct ID.
config DataDigitaloceanDropletConfig No description.
scopeRequired
  • Type: github.com/aws/constructs-go/constructs/v10.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 
func ToString() *string

Returns a string representation of this construct.

AddOverride 
func AddOverride(path *string, value interface{})
pathRequired
  • Type: *string
valueRequired
  • Type: interface{}
OverrideLogicalId 
func OverrideLogicalId(newLogicalId *string)

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

newLogicalIdRequired
  • Type: *string

The new logical ID to use for this stack element.

ResetOverrideLogicalId 
func ResetOverrideLogicalId()

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

ToHclTerraform 
func ToHclTerraform() interface{}

Adds this resource to the terraform JSON output.

ToMetadata 
func ToMetadata() interface{}
ToTerraform 
func ToTerraform() interface{}

Adds this resource to the terraform JSON output.

GetAnyMapAttribute 
func GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}
terraformAttributeRequired
  • Type: *string
GetBooleanAttribute 
func GetBooleanAttribute(terraformAttribute *string) IResolvable
terraformAttributeRequired
  • Type: *string
GetBooleanMapAttribute 
func GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool
terraformAttributeRequired
  • Type: *string
GetListAttribute 
func GetListAttribute(terraformAttribute *string) *[]*string
terraformAttributeRequired
  • Type: *string
GetNumberAttribute 
func GetNumberAttribute(terraformAttribute *string) *f64
terraformAttributeRequired
  • Type: *string
GetNumberListAttribute 
func GetNumberListAttribute(terraformAttribute *string) *[]*f64
terraformAttributeRequired
  • Type: *string
GetNumberMapAttribute 
func GetNumberMapAttribute(terraformAttribute *string) *map[string]*f64
terraformAttributeRequired
  • Type: *string
GetStringAttribute 
func GetStringAttribute(terraformAttribute *string) *string
terraformAttributeRequired
  • Type: *string
GetStringMapAttribute 
func GetStringMapAttribute(terraformAttribute *string) *map[string]*string
terraformAttributeRequired
  • Type: *string
InterpolationForAttribute 
func InterpolationForAttribute(terraformAttribute *string) IResolvable
terraformAttributeRequired
  • Type: *string
ResetGpu 
func ResetGpu()
ResetId 
func ResetId()
ResetName 
func ResetName()
ResetTag 
func 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 
import "github.com/cdktf/cdktf-provider-digitalocean-go/digitalocean/v11/datadigitaloceandroplet"

datadigitaloceandroplet.DataDigitaloceanDroplet_IsConstruct(x interface{}) *bool

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: interface{}

Any object.

IsTerraformElement 
import "github.com/cdktf/cdktf-provider-digitalocean-go/digitalocean/v11/datadigitaloceandroplet"

datadigitaloceandroplet.DataDigitaloceanDroplet_IsTerraformElement(x interface{}) *bool
xRequired
  • Type: interface{}
IsTerraformDataSource 
import "github.com/cdktf/cdktf-provider-digitalocean-go/digitalocean/v11/datadigitaloceandroplet"

datadigitaloceandroplet.DataDigitaloceanDroplet_IsTerraformDataSource(x interface{}) *bool
xRequired
  • Type: interface{}
GenerateConfigForImport 
import "github.com/cdktf/cdktf-provider-digitalocean-go/digitalocean/v11/datadigitaloceandroplet"

datadigitaloceandroplet.DataDigitaloceanDroplet_GenerateConfigForImport(scope Construct, importToId *string, importFromId *string, provider TerraformProvider) ImportableResource

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

scopeRequired
  • Type: github.com/aws/constructs-go/constructs/v10.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: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider

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

Properties

Name Type Description
Node github.com/aws/constructs-go/constructs/v10.Node The tree node.
CdktfStack github.com/hashicorp/terraform-cdk-go/cdktf.TerraformStack No description.
Fqn *string No description.
FriendlyUniqueId *string No description.
TerraformMetaArguments *map[string]interface{} No description.
TerraformResourceType *string No description.
TerraformGeneratorMetadata github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProviderGeneratorMetadata No description.
Count interface{} No description.
DependsOn *[]*string No description.
ForEach github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator No description.
Lifecycle github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle No description.
Provider github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider No description.
Backups github.com/hashicorp/terraform-cdk-go/cdktf.IResolvable No description.
CreatedAt *string No description.
Disk *f64 No description.
Image *string No description.
Ipv4Address *string No description.
Ipv4AddressPrivate *string No description.
Ipv6 github.com/hashicorp/terraform-cdk-go/cdktf.IResolvable No description.
Ipv6Address *string No description.
Ipv6AddressPrivate *string No description.
Locked github.com/hashicorp/terraform-cdk-go/cdktf.IResolvable No description.
Memory *f64 No description.
Monitoring github.com/hashicorp/terraform-cdk-go/cdktf.IResolvable No description.
PriceHourly *f64 No description.
PriceMonthly *f64 No description.
PrivateNetworking github.com/hashicorp/terraform-cdk-go/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 *f64 No description.
VolumeIds *[]*string No description.
VpcUuid *string No description.
GpuInput interface{} No description.
IdInput *f64 No description.
NameInput *string No description.
TagInput *string No description.
Gpu interface{} No description.
Id *f64 No description.
Name *string No description.
Tag *string No description.
NodeRequired 
func Node() Node
  • Type: github.com/aws/constructs-go/constructs/v10.Node

The tree node.

CdktfStackRequired 
func CdktfStack() TerraformStack
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformStack
FqnRequired 
func Fqn() *string
  • Type: *string
FriendlyUniqueIdRequired 
func FriendlyUniqueId() *string
  • Type: *string
TerraformMetaArgumentsRequired 
func TerraformMetaArguments() *map[string]interface{}
  • Type: *map[string]interface{}
TerraformResourceTypeRequired 
func TerraformResourceType() *string
  • Type: *string
TerraformGeneratorMetadataOptional 
func TerraformGeneratorMetadata() TerraformProviderGeneratorMetadata
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProviderGeneratorMetadata
CountOptional 
func Count() interface{}
  • Type: interface{}
DependsOnOptional 
func DependsOn() *[]*string
  • Type: *[]*string
ForEachOptional 
func ForEach() ITerraformIterator
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator
LifecycleOptional 
func Lifecycle() TerraformResourceLifecycle
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle
ProviderOptional 
func Provider() TerraformProvider
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider
BackupsRequired 
func Backups() IResolvable
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.IResolvable
CreatedAtRequired 
func CreatedAt() *string
  • Type: *string
DiskRequired 
func Disk() *f64
  • Type: *f64
ImageRequired 
func Image() *string
  • Type: *string
Ipv4AddressRequired 
func Ipv4Address() *string
  • Type: *string
Ipv4AddressPrivateRequired 
func Ipv4AddressPrivate() *string
  • Type: *string
Ipv6Required 
func Ipv6() IResolvable
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.IResolvable
Ipv6AddressRequired 
func Ipv6Address() *string
  • Type: *string
Ipv6AddressPrivateRequired 
func Ipv6AddressPrivate() *string
  • Type: *string
LockedRequired 
func Locked() IResolvable
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.IResolvable
MemoryRequired 
func Memory() *f64
  • Type: *f64
MonitoringRequired 
func Monitoring() IResolvable
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.IResolvable
PriceHourlyRequired 
func PriceHourly() *f64
  • Type: *f64
PriceMonthlyRequired 
func PriceMonthly() *f64
  • Type: *f64
PrivateNetworkingRequired 
func PrivateNetworking() IResolvable
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.IResolvable
RegionRequired 
func Region() *string
  • Type: *string
SizeRequired 
func Size() *string
  • Type: *string
StatusRequired 
func Status() *string
  • Type: *string
TagsRequired 
func Tags() *[]*string
  • Type: *[]*string
UrnRequired 
func Urn() *string
  • Type: *string
VcpusRequired 
func Vcpus() *f64
  • Type: *f64
VolumeIdsRequired 
func VolumeIds() *[]*string
  • Type: *[]*string
VpcUuidRequired 
func VpcUuid() *string
  • Type: *string
GpuInputOptional 
func GpuInput() interface{}
  • Type: interface{}
IdInputOptional 
func IdInput() *f64
  • Type: *f64
NameInputOptional 
func NameInput() *string
  • Type: *string
TagInputOptional 
func TagInput() *string
  • Type: *string
GpuRequired 
func Gpu() interface{}
  • Type: interface{}
IdRequired 
func Id() *f64
  • Type: *f64
NameRequired 
func Name() *string
  • Type: *string
TagRequired 
func Tag() *string
  • Type: *string

Constants

Name Type Description
TfResourceType *string No description.
TfResourceTypeRequired 
func TfResourceType() *string
  • Type: *string

Structs

DataDigitaloceanDropletConfig

Initializer 

import "github.com/cdktf/cdktf-provider-digitalocean-go/digitalocean/v11/datadigitaloceandroplet"

&datadigitaloceandroplet.DataDigitaloceanDropletConfig {
	Connection: interface{},
	Count: interface{},
	DependsOn: *[]github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformDependable,
	ForEach: github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator,
	Lifecycle: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle,
	Provider: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider,
	Provisioners: *[]interface{},
	Gpu: interface{},
	Id: *f64,
	Name: *string,
	Tag: *string,
}

Properties

Name Type Description
Connection interface{} No description.
Count interface{} No description.
DependsOn *[]github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformDependable No description.
ForEach github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator No description.
Lifecycle github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle No description.
Provider github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider No description.
Provisioners *[]interface{} No description.
Gpu interface{} Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/data-sources/droplet#gpu DataDigitaloceanDroplet#gpu}.
Id *f64 id of the Droplet.
Name *string name of the Droplet.
Tag *string unique tag of the Droplet.
ConnectionOptional 
Connection interface{}
  • Type: interface{}
CountOptional 
Count interface{}
  • Type: interface{}
DependsOnOptional 
DependsOn *[]ITerraformDependable
  • Type: *[]github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformDependable
ForEachOptional 
ForEach ITerraformIterator
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator
LifecycleOptional 
Lifecycle TerraformResourceLifecycle
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle
ProviderOptional 
Provider TerraformProvider
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider
ProvisionersOptional 
Provisioners *[]interface{}
  • Type: *[]interface{}
GpuOptional 
Gpu interface{}
  • Type: interface{}

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

IdOptional 
Id *f64
  • Type: *f64

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 
Name *string
  • 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 
Tag *string
  • 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}