Skip to content

Latest commit

 

History

History
2518 lines (1571 loc) · 102 KB

droplet.typescript.md

File metadata and controls

2518 lines (1571 loc) · 102 KB
Raw

droplet Submodule

Constructs

Droplet

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

Initializers 

import { droplet } from '@cdktf/provider-digitalocean'

new droplet.Droplet(scope: Construct, id: string, config: DropletConfig)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id string The scoped construct ID.
config DropletConfig 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

configRequired

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 No description.
toMetadata No description.
toTerraform Adds this resource to the terraform JSON output.
addMoveTarget Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
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.
hasResourceMove No description.
importFrom No description.
interpolationForAttribute No description.
moveFromId Move the resource corresponding to "id" to this resource.
moveTo Moves this resource to the target resource given by moveTarget.
moveToId Moves this resource to the resource corresponding to "id".
putBackupPolicy No description.
putTimeouts No description.
resetBackupPolicy No description.
resetBackups No description.
resetDropletAgent No description.
resetGracefulShutdown No description.
resetId No description.
resetIpv6 No description.
resetIpv6Address No description.
resetMonitoring No description.
resetPrivateNetworking No description.
resetRegion No description.
resetResizeDisk No description.
resetSshKeys No description.
resetTags No description.
resetTimeouts No description.
resetUserData No description.
resetVolumeIds No description.
resetVpcUuid No description.
toString 
public toString(): string

Returns a string representation of this construct.

addOverride 
public addOverride(path: string, value: any): void
pathRequired
  • Type: string
valueRequired
  • Type: any
overrideLogicalId 
public overrideLogicalId(newLogicalId: string): void

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

newLogicalIdRequired
  • Type: string

The new logical ID to use for this stack element.

resetOverrideLogicalId 
public resetOverrideLogicalId(): void

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

toHclTerraform 
public toHclTerraform(): any
toMetadata 
public toMetadata(): any
toTerraform 
public toTerraform(): any

Adds this resource to the terraform JSON output.

addMoveTarget 
public addMoveTarget(moveTarget: string): void

Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.

moveTargetRequired
  • Type: string

The string move target that will correspond to this resource.

getAnyMapAttribute 
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
terraformAttributeRequired
  • Type: string
getBooleanAttribute 
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string
getBooleanMapAttribute 
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
terraformAttributeRequired
  • Type: string
getListAttribute 
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string
getNumberAttribute 
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string
getNumberListAttribute 
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string
getNumberMapAttribute 
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
terraformAttributeRequired
  • Type: string
getStringAttribute 
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string
getStringMapAttribute 
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
terraformAttributeRequired
  • Type: string
hasResourceMove 
public hasResourceMove(): TerraformResourceMoveByTarget | TerraformResourceMoveById
importFrom 
public importFrom(id: string, provider?: TerraformProvider): void
idRequired
  • Type: string
providerOptional
  • Type: cdktf.TerraformProvider
interpolationForAttribute 
public interpolationForAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string
moveFromId 
public moveFromId(id: string): void

Move the resource corresponding to "id" to this resource.

Note that the resource being moved from must be marked as moved using it's instance function.

idRequired
  • Type: string

Full id of resource being moved from, e.g. "aws_s3_bucket.example".

moveTo 
public moveTo(moveTarget: string, index?: string | number): void

Moves this resource to the target resource given by moveTarget.

moveTargetRequired
  • Type: string

The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.

indexOptional
  • Type: string | number

Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.

moveToId 
public moveToId(id: string): void

Moves this resource to the resource corresponding to "id".

idRequired
  • Type: string

Full id of resource to move to, e.g. "aws_s3_bucket.example".

putBackupPolicy 
public putBackupPolicy(value: DropletBackupPolicy): void
valueRequired
putTimeouts 
public putTimeouts(value: DropletTimeouts): void
valueRequired
resetBackupPolicy 
public resetBackupPolicy(): void
resetBackups 
public resetBackups(): void
resetDropletAgent 
public resetDropletAgent(): void
resetGracefulShutdown 
public resetGracefulShutdown(): void
resetId 
public resetId(): void
resetIpv6 
public resetIpv6(): void
resetIpv6Address 
public resetIpv6Address(): void
resetMonitoring 
public resetMonitoring(): void
resetPrivateNetworking 
public resetPrivateNetworking(): void
resetRegion 
public resetRegion(): void
resetResizeDisk 
public resetResizeDisk(): void
resetSshKeys 
public resetSshKeys(): void
resetTags 
public resetTags(): void
resetTimeouts 
public resetTimeouts(): void
resetUserData 
public resetUserData(): void
resetVolumeIds 
public resetVolumeIds(): void
resetVpcUuid 
public resetVpcUuid(): void

Static Functions

Name Description
isConstruct Checks if x is a construct.
isTerraformElement No description.
isTerraformResource No description.
generateConfigForImport Generates CDKTF code for importing a Droplet resource upon running "cdktf plan ".
isConstruct 
import { droplet } from '@cdktf/provider-digitalocean'

droplet.Droplet.isConstruct(x: 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.

xRequired
  • Type: any

Any object.

isTerraformElement 
import { droplet } from '@cdktf/provider-digitalocean'

droplet.Droplet.isTerraformElement(x: any)
xRequired
  • Type: any
isTerraformResource 
import { droplet } from '@cdktf/provider-digitalocean'

droplet.Droplet.isTerraformResource(x: any)
xRequired
  • Type: any
generateConfigForImport 
import { droplet } from '@cdktf/provider-digitalocean'

droplet.Droplet.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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

importFromIdRequired
  • Type: string

The id of the existing Droplet that should be imported.

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

providerOptional
  • Type: cdktf.TerraformProvider

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

Properties

Name Type Description
node constructs.Node The tree node.
cdktfStack cdktf.TerraformStack No description.
fqn string No description.
friendlyUniqueId string No description.
terraformMetaArguments {[ key: string ]: any} No description.
terraformResourceType string No description.
terraformGeneratorMetadata cdktf.TerraformProviderGeneratorMetadata No description.
connection cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection No description.
count number | cdktf.TerraformCount No description.
dependsOn string[] No description.
forEach cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[] No description.
backupPolicy DropletBackupPolicyOutputReference No description.
createdAt string No description.
disk number No description.
ipv4Address string No description.
ipv4AddressPrivate string No description.
locked cdktf.IResolvable No description.
memory number No description.
priceHourly number No description.
priceMonthly number No description.
status string No description.
timeouts DropletTimeoutsOutputReference No description.
urn string No description.
vcpus number No description.
backupPolicyInput DropletBackupPolicy No description.
backupsInput boolean | cdktf.IResolvable No description.
dropletAgentInput boolean | cdktf.IResolvable No description.
gracefulShutdownInput boolean | cdktf.IResolvable No description.
idInput string No description.
imageInput string No description.
ipv6AddressInput string No description.
ipv6Input boolean | cdktf.IResolvable No description.
monitoringInput boolean | cdktf.IResolvable No description.
nameInput string No description.
privateNetworkingInput boolean | cdktf.IResolvable No description.
regionInput string No description.
resizeDiskInput boolean | cdktf.IResolvable No description.
sizeInput string No description.
sshKeysInput string[] No description.
tagsInput string[] No description.
timeoutsInput cdktf.IResolvable | DropletTimeouts No description.
userDataInput string No description.
volumeIdsInput string[] No description.
vpcUuidInput string No description.
backups boolean | cdktf.IResolvable No description.
dropletAgent boolean | cdktf.IResolvable No description.
gracefulShutdown boolean | cdktf.IResolvable No description.
id string No description.
image string No description.
ipv6 boolean | cdktf.IResolvable No description.
ipv6Address string No description.
monitoring boolean | cdktf.IResolvable No description.
name string No description.
privateNetworking boolean | cdktf.IResolvable No description.
region string No description.
resizeDisk boolean | cdktf.IResolvable No description.
size string No description.
sshKeys string[] No description.
tags string[] No description.
userData string No description.
volumeIds string[] No description.
vpcUuid string No description.
nodeRequired 
public readonly node: Node;
  • Type: constructs.Node

The tree node.

cdktfStackRequired 
public readonly cdktfStack: TerraformStack;
  • Type: cdktf.TerraformStack
fqnRequired 
public readonly fqn: string;
  • Type: string
friendlyUniqueIdRequired 
public readonly friendlyUniqueId: string;
  • Type: string
terraformMetaArgumentsRequired 
public readonly terraformMetaArguments: {[ key: string ]: any};
  • Type: {[ key: string ]: any}
terraformResourceTypeRequired 
public readonly terraformResourceType: string;
  • Type: string
terraformGeneratorMetadataOptional 
public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;
  • Type: cdktf.TerraformProviderGeneratorMetadata
connectionOptional 
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
  • Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection
countOptional 
public readonly count: number | TerraformCount;
  • Type: number | cdktf.TerraformCount
dependsOnOptional 
public readonly dependsOn: string[];
  • Type: string[]
forEachOptional 
public readonly forEach: ITerraformIterator;
  • Type: cdktf.ITerraformIterator
lifecycleOptional 
public readonly lifecycle: TerraformResourceLifecycle;
  • Type: cdktf.TerraformResourceLifecycle
providerOptional 
public readonly provider: TerraformProvider;
  • Type: cdktf.TerraformProvider
provisionersOptional 
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
  • Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]
backupPolicyRequired 
public readonly backupPolicy: DropletBackupPolicyOutputReference;
createdAtRequired 
public readonly createdAt: string;
  • Type: string
diskRequired 
public readonly disk: number;
  • Type: number
ipv4AddressRequired 
public readonly ipv4Address: string;
  • Type: string
ipv4AddressPrivateRequired 
public readonly ipv4AddressPrivate: string;
  • Type: string
lockedRequired 
public readonly locked: IResolvable;
  • Type: cdktf.IResolvable
memoryRequired 
public readonly memory: number;
  • Type: number
priceHourlyRequired 
public readonly priceHourly: number;
  • Type: number
priceMonthlyRequired 
public readonly priceMonthly: number;
  • Type: number
statusRequired 
public readonly status: string;
  • Type: string
timeoutsRequired 
public readonly timeouts: DropletTimeoutsOutputReference;
urnRequired 
public readonly urn: string;
  • Type: string
vcpusRequired 
public readonly vcpus: number;
  • Type: number
backupPolicyInputOptional 
public readonly backupPolicyInput: DropletBackupPolicy;
backupsInputOptional 
public readonly backupsInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
dropletAgentInputOptional 
public readonly dropletAgentInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
gracefulShutdownInputOptional 
public readonly gracefulShutdownInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
idInputOptional 
public readonly idInput: string;
  • Type: string
imageInputOptional 
public readonly imageInput: string;
  • Type: string
ipv6AddressInputOptional 
public readonly ipv6AddressInput: string;
  • Type: string
ipv6InputOptional 
public readonly ipv6Input: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
monitoringInputOptional 
public readonly monitoringInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
nameInputOptional 
public readonly nameInput: string;
  • Type: string
privateNetworkingInputOptional 
public readonly privateNetworkingInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
regionInputOptional 
public readonly regionInput: string;
  • Type: string
resizeDiskInputOptional 
public readonly resizeDiskInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
sizeInputOptional 
public readonly sizeInput: string;
  • Type: string
sshKeysInputOptional 
public readonly sshKeysInput: string[];
  • Type: string[]
tagsInputOptional 
public readonly tagsInput: string[];
  • Type: string[]
timeoutsInputOptional 
public readonly timeoutsInput: IResolvable | DropletTimeouts;
userDataInputOptional 
public readonly userDataInput: string;
  • Type: string
volumeIdsInputOptional 
public readonly volumeIdsInput: string[];
  • Type: string[]
vpcUuidInputOptional 
public readonly vpcUuidInput: string;
  • Type: string
backupsRequired 
public readonly backups: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
dropletAgentRequired 
public readonly dropletAgent: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
gracefulShutdownRequired 
public readonly gracefulShutdown: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
idRequired 
public readonly id: string;
  • Type: string
imageRequired 
public readonly image: string;
  • Type: string
ipv6Required 
public readonly ipv6: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
ipv6AddressRequired 
public readonly ipv6Address: string;
  • Type: string
monitoringRequired 
public readonly monitoring: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
nameRequired 
public readonly name: string;
  • Type: string
privateNetworkingRequired 
public readonly privateNetworking: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
regionRequired 
public readonly region: string;
  • Type: string
resizeDiskRequired 
public readonly resizeDisk: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
sizeRequired 
public readonly size: string;
  • Type: string
sshKeysRequired 
public readonly sshKeys: string[];
  • Type: string[]
tagsRequired 
public readonly tags: string[];
  • Type: string[]
userDataRequired 
public readonly userData: string;
  • Type: string
volumeIdsRequired 
public readonly volumeIds: string[];
  • Type: string[]
vpcUuidRequired 
public readonly vpcUuid: string;
  • Type: string

Constants

Name Type Description
tfResourceType string No description.
tfResourceTypeRequired 
public readonly tfResourceType: string;
  • Type: string

Structs

DropletBackupPolicy

Initializer 

import { droplet } from '@cdktf/provider-digitalocean'

const dropletBackupPolicy: droplet.DropletBackupPolicy = { ... }

Properties

Name Type Description
hour number Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/droplet#hour Droplet#hour}.
plan string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/droplet#plan Droplet#plan}.
weekday string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/droplet#weekday Droplet#weekday}.
hourOptional 
public readonly hour: number;
  • Type: number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/droplet#hour Droplet#hour}.

planOptional 
public readonly plan: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/droplet#plan Droplet#plan}.

weekdayOptional 
public readonly weekday: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/droplet#weekday Droplet#weekday}.

DropletConfig

Initializer 

import { droplet } from '@cdktf/provider-digitalocean'

const dropletConfig: droplet.DropletConfig = { ... }

Properties

Name Type Description
connection cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection No description.
count number | cdktf.TerraformCount No description.
dependsOn cdktf.ITerraformDependable[] No description.
forEach cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[] No description.
image string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/droplet#image Droplet#image}.
name string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/droplet#name Droplet#name}.
size string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/droplet#size Droplet#size}.
backupPolicy DropletBackupPolicy backup_policy block.
backups boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/droplet#backups Droplet#backups}.
dropletAgent boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/droplet#droplet_agent Droplet#droplet_agent}.
gracefulShutdown boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/droplet#graceful_shutdown Droplet#graceful_shutdown}.
id string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/droplet#id Droplet#id}.
ipv6 boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/droplet#ipv6 Droplet#ipv6}.
ipv6Address string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/droplet#ipv6_address Droplet#ipv6_address}.
monitoring boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/droplet#monitoring Droplet#monitoring}.
privateNetworking boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/droplet#private_networking Droplet#private_networking}.
region string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/droplet#region Droplet#region}.
resizeDisk boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/droplet#resize_disk Droplet#resize_disk}.
sshKeys string[] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/droplet#ssh_keys Droplet#ssh_keys}.
tags string[] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/droplet#tags Droplet#tags}.
timeouts DropletTimeouts timeouts block.
userData string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/droplet#user_data Droplet#user_data}.
volumeIds string[] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/droplet#volume_ids Droplet#volume_ids}.
vpcUuid string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/droplet#vpc_uuid Droplet#vpc_uuid}.
connectionOptional 
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
  • Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection
countOptional 
public readonly count: number | TerraformCount;
  • Type: number | cdktf.TerraformCount
dependsOnOptional 
public readonly dependsOn: ITerraformDependable[];
  • Type: cdktf.ITerraformDependable[]
forEachOptional 
public readonly forEach: ITerraformIterator;
  • Type: cdktf.ITerraformIterator
lifecycleOptional 
public readonly lifecycle: TerraformResourceLifecycle;
  • Type: cdktf.TerraformResourceLifecycle
providerOptional 
public readonly provider: TerraformProvider;
  • Type: cdktf.TerraformProvider
provisionersOptional 
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
  • Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]
imageRequired 
public readonly image: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/droplet#image Droplet#image}.

nameRequired 
public readonly name: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/droplet#name Droplet#name}.

sizeRequired 
public readonly size: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/droplet#size Droplet#size}.

backupPolicyOptional 
public readonly backupPolicy: DropletBackupPolicy;

backup_policy block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/droplet#backup_policy Droplet#backup_policy}

backupsOptional 
public readonly backups: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/droplet#backups Droplet#backups}.

dropletAgentOptional 
public readonly dropletAgent: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/droplet#droplet_agent Droplet#droplet_agent}.

gracefulShutdownOptional 
public readonly gracefulShutdown: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/droplet#graceful_shutdown Droplet#graceful_shutdown}.

idOptional 
public readonly id: string;
  • Type: string

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

ipv6Optional 
public readonly ipv6: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/droplet#ipv6 Droplet#ipv6}.

ipv6AddressOptional 
public readonly ipv6Address: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/droplet#ipv6_address Droplet#ipv6_address}.

monitoringOptional 
public readonly monitoring: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/droplet#monitoring Droplet#monitoring}.

privateNetworkingOptional 
public readonly privateNetworking: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/droplet#private_networking Droplet#private_networking}.

regionOptional 
public readonly region: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/droplet#region Droplet#region}.

resizeDiskOptional 
public readonly resizeDisk: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/droplet#resize_disk Droplet#resize_disk}.

sshKeysOptional 
public readonly sshKeys: string[];
  • Type: string[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/droplet#ssh_keys Droplet#ssh_keys}.

tagsOptional 
public readonly tags: string[];
  • Type: string[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/droplet#tags Droplet#tags}.

timeoutsOptional 
public readonly timeouts: DropletTimeouts;

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/droplet#timeouts Droplet#timeouts}

userDataOptional 
public readonly userData: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/droplet#user_data Droplet#user_data}.

volumeIdsOptional 
public readonly volumeIds: string[];
  • Type: string[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/droplet#volume_ids Droplet#volume_ids}.

vpcUuidOptional 
public readonly vpcUuid: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/droplet#vpc_uuid Droplet#vpc_uuid}.

DropletTimeouts

Initializer 

import { droplet } from '@cdktf/provider-digitalocean'

const dropletTimeouts: droplet.DropletTimeouts = { ... }

Properties

Name Type Description
create string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/droplet#create Droplet#create}.
delete string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/droplet#delete Droplet#delete}.
update string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/droplet#update Droplet#update}.
createOptional 
public readonly create: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/droplet#create Droplet#create}.

deleteOptional 
public readonly delete: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/droplet#delete Droplet#delete}.

updateOptional 
public readonly update: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/droplet#update Droplet#update}.

Classes

DropletBackupPolicyOutputReference

Initializers 

import { droplet } from '@cdktf/provider-digitalocean'

new droplet.DropletBackupPolicyOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)
Name Type Description
terraformResource cdktf.IInterpolatingParent The parent resource.
terraformAttribute string The attribute on the parent resource this class is referencing.
terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.

Methods

Name Description
computeFqn No description.
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.
resolve Produce the Token's value at resolution time.
toString Return a string representation of this resolvable object.
resetHour No description.
resetPlan No description.
resetWeekday No description.
computeFqn 
public computeFqn(): string
getAnyMapAttribute 
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
terraformAttributeRequired
  • Type: string
getBooleanAttribute 
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string
getBooleanMapAttribute 
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
terraformAttributeRequired
  • Type: string
getListAttribute 
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string
getNumberAttribute 
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string
getNumberListAttribute 
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string
getNumberMapAttribute 
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
terraformAttributeRequired
  • Type: string
getStringAttribute 
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string
getStringMapAttribute 
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
terraformAttributeRequired
  • Type: string
interpolationForAttribute 
public interpolationForAttribute(property: string): IResolvable
propertyRequired
  • Type: string
resolve 
public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext
toString 
public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

resetHour 
public resetHour(): void
resetPlan 
public resetPlan(): void
resetWeekday 
public resetWeekday(): void

Properties

Name Type Description
creationStack string[] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn string No description.
hourInput number No description.
planInput string No description.
weekdayInput string No description.
hour number No description.
plan string No description.
weekday string No description.
internalValue DropletBackupPolicy No description.
creationStackRequired 
public readonly creationStack: string[];
  • Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

fqnRequired 
public readonly fqn: string;
  • Type: string
hourInputOptional 
public readonly hourInput: number;
  • Type: number
planInputOptional 
public readonly planInput: string;
  • Type: string
weekdayInputOptional 
public readonly weekdayInput: string;
  • Type: string
hourRequired 
public readonly hour: number;
  • Type: number
planRequired 
public readonly plan: string;
  • Type: string
weekdayRequired 
public readonly weekday: string;
  • Type: string
internalValueOptional 
public readonly internalValue: DropletBackupPolicy;

DropletTimeoutsOutputReference

Initializers 

import { droplet } from '@cdktf/provider-digitalocean'

new droplet.DropletTimeoutsOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)
Name Type Description
terraformResource cdktf.IInterpolatingParent The parent resource.
terraformAttribute string The attribute on the parent resource this class is referencing.
terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.

Methods

Name Description
computeFqn No description.
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.
resolve Produce the Token's value at resolution time.
toString Return a string representation of this resolvable object.
resetCreate No description.
resetDelete No description.
resetUpdate No description.
computeFqn 
public computeFqn(): string
getAnyMapAttribute 
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
terraformAttributeRequired
  • Type: string
getBooleanAttribute 
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string
getBooleanMapAttribute 
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
terraformAttributeRequired
  • Type: string
getListAttribute 
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string
getNumberAttribute 
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string
getNumberListAttribute 
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string
getNumberMapAttribute 
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
terraformAttributeRequired
  • Type: string
getStringAttribute 
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string
getStringMapAttribute 
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
terraformAttributeRequired
  • Type: string
interpolationForAttribute 
public interpolationForAttribute(property: string): IResolvable
propertyRequired
  • Type: string
resolve 
public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext
toString 
public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

resetCreate 
public resetCreate(): void
resetDelete 
public resetDelete(): void
resetUpdate 
public resetUpdate(): void

Properties

Name Type Description
creationStack string[] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn string No description.
createInput string No description.
deleteInput string No description.
updateInput string No description.
create string No description.
delete string No description.
update string No description.
internalValue cdktf.IResolvable | DropletTimeouts No description.
creationStackRequired 
public readonly creationStack: string[];
  • Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

fqnRequired 
public readonly fqn: string;
  • Type: string
createInputOptional 
public readonly createInput: string;
  • Type: string
deleteInputOptional 
public readonly deleteInput: string;
  • Type: string
updateInputOptional 
public readonly updateInput: string;
  • Type: string
createRequired 
public readonly create: string;
  • Type: string
deleteRequired 
public readonly delete: string;
  • Type: string
updateRequired 
public readonly update: string;
  • Type: string
internalValueOptional 
public readonly internalValue: IResolvable | DropletTimeouts;