databaseCluster.typescript.md

databaseCluster Submodule

Constructs

DatabaseCluster

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

Initializers

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

new databaseCluster.DatabaseCluster(scope: Construct, id: string, config: DatabaseClusterConfig)

Name	Type	Description
scope	constructs.Construct	The scope in which to define this construct.
id	string	The scoped construct ID.
config	DatabaseClusterConfig	No description.

---

scope^Required

• Type: constructs.Construct

The scope in which to define this construct.

---

id^Required

• Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope

---

config^Required

• Type: DatabaseClusterConfig

---

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".
putBackupRestore	No description.
putMaintenanceWindow	No description.
putTimeouts	No description.
resetBackupRestore	No description.
resetEvictionPolicy	No description.
resetId	No description.
resetMaintenanceWindow	No description.
resetPrivateNetworkUuid	No description.
resetProjectId	No description.
resetSqlMode	No description.
resetStorageSizeMib	No description.
resetTags	No description.
resetTimeouts	No description.
resetVersion	No description.

---

toString

public toString(): string

Returns a string representation of this construct.

addOverride

public addOverride(path: string, value: any): void

path^Required

• Type: string

---

value^Required

• Type: any

---

overrideLogicalId

public overrideLogicalId(newLogicalId: string): void

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

newLogicalId^Required

• 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.

moveTarget^Required

• Type: string

The string move target that will correspond to this resource.

---

getAnyMapAttribute

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

terraformAttribute^Required

• Type: string

---

getBooleanAttribute

public getBooleanAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

getBooleanMapAttribute

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

terraformAttribute^Required

• Type: string

---

getListAttribute

public getListAttribute(terraformAttribute: string): string[]

terraformAttribute^Required

• Type: string

---

getNumberAttribute

public getNumberAttribute(terraformAttribute: string): number

terraformAttribute^Required

• Type: string

---

getNumberListAttribute

public getNumberListAttribute(terraformAttribute: string): number[]

terraformAttribute^Required

• Type: string

---

getNumberMapAttribute

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

terraformAttribute^Required

• Type: string

---

getStringAttribute

public getStringAttribute(terraformAttribute: string): string

terraformAttribute^Required

• Type: string

---

getStringMapAttribute

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

terraformAttribute^Required

• Type: string

---

hasResourceMove

public hasResourceMove(): TerraformResourceMoveByTarget | TerraformResourceMoveById

importFrom

public importFrom(id: string, provider?: TerraformProvider): void

id^Required

• Type: string

---

provider^Optional

• Type: cdktf.TerraformProvider

---

interpolationForAttribute

public interpolationForAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• 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.

id^Required

• 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.

moveTarget^Required

• Type: string

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

---

index^Optional

• 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".

id^Required

• Type: string

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

---

putBackupRestore

public putBackupRestore(value: DatabaseClusterBackupRestore): void

value^Required

• Type: DatabaseClusterBackupRestore

---

putMaintenanceWindow

public putMaintenanceWindow(value: IResolvable | DatabaseClusterMaintenanceWindow[]): void

value^Required

• Type: cdktf.IResolvable | DatabaseClusterMaintenanceWindow[]

---

putTimeouts

public putTimeouts(value: DatabaseClusterTimeouts): void

value^Required

• Type: DatabaseClusterTimeouts

---

resetBackupRestore

public resetBackupRestore(): void

resetEvictionPolicy

public resetEvictionPolicy(): void

resetId

public resetId(): void

resetMaintenanceWindow

public resetMaintenanceWindow(): void

resetPrivateNetworkUuid

public resetPrivateNetworkUuid(): void

resetProjectId

public resetProjectId(): void

resetSqlMode

public resetSqlMode(): void

resetStorageSizeMib

public resetStorageSizeMib(): void

resetTags

public resetTags(): void

resetTimeouts

public resetTimeouts(): void

resetVersion

public resetVersion(): 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 DatabaseCluster resource upon running "cdktf plan ".

---

isConstruct

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

databaseCluster.DatabaseCluster.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.

x^Required

• Type: any

Any object.

---

isTerraformElement

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

databaseCluster.DatabaseCluster.isTerraformElement(x: any)

x^Required

• Type: any

---

isTerraformResource

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

databaseCluster.DatabaseCluster.isTerraformResource(x: any)

x^Required

• Type: any

---

generateConfigForImport

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

databaseCluster.DatabaseCluster.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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

scope^Required

• Type: constructs.Construct

The scope in which to define this construct.

---

importToId^Required

• Type: string

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

---

importFromId^Required

• Type: string

The id of the existing DatabaseCluster that should be imported.

Refer to the {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/database_cluster#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 DatabaseCluster 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.
backupRestore	DatabaseClusterBackupRestoreOutputReference	No description.
database	string	No description.
host	string	No description.
maintenanceWindow	DatabaseClusterMaintenanceWindowList	No description.
password	string	No description.
port	number	No description.
privateHost	string	No description.
privateUri	string	No description.
timeouts	DatabaseClusterTimeoutsOutputReference	No description.
uiDatabase	string	No description.
uiHost	string	No description.
uiPassword	string	No description.
uiPort	number	No description.
uiUri	string	No description.
uiUser	string	No description.
uri	string	No description.
urn	string	No description.
user	string	No description.
backupRestoreInput	DatabaseClusterBackupRestore	No description.
engineInput	string	No description.
evictionPolicyInput	string	No description.
idInput	string	No description.
maintenanceWindowInput	cdktf.IResolvable | DatabaseClusterMaintenanceWindow[]	No description.
nameInput	string	No description.
nodeCountInput	number	No description.
privateNetworkUuidInput	string	No description.
projectIdInput	string	No description.
regionInput	string	No description.
sizeInput	string	No description.
sqlModeInput	string	No description.
storageSizeMibInput	string	No description.
tagsInput	string[]	No description.
timeoutsInput	cdktf.IResolvable | DatabaseClusterTimeouts	No description.
versionInput	string	No description.
engine	string	No description.
evictionPolicy	string	No description.
id	string	No description.
name	string	No description.
nodeCount	number	No description.
privateNetworkUuid	string	No description.
projectId	string	No description.
region	string	No description.
size	string	No description.
sqlMode	string	No description.
storageSizeMib	string	No description.
tags	string[]	No description.
version	string	No description.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

cdktfStack^Required

public readonly cdktfStack: TerraformStack;

• Type: cdktf.TerraformStack

---

fqn^Required

public readonly fqn: string;

• Type: string

---

friendlyUniqueId^Required

public readonly friendlyUniqueId: string;

• Type: string

---

terraformMetaArguments^Required

public readonly terraformMetaArguments: {[ key: string ]: any};

• Type: {[ key: string ]: any}

---

terraformResourceType^Required

public readonly terraformResourceType: string;

• Type: string

---

terraformGeneratorMetadata^Optional

public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;

• Type: cdktf.TerraformProviderGeneratorMetadata

---

connection^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

• Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

---

count^Optional

public readonly count: number | TerraformCount;

• Type: number | cdktf.TerraformCount

---

dependsOn^Optional

public readonly dependsOn: string[];

• Type: string[]

---

forEach^Optional

public readonly forEach: ITerraformIterator;

• Type: cdktf.ITerraformIterator

---

lifecycle^Optional

public readonly lifecycle: TerraformResourceLifecycle;

• Type: cdktf.TerraformResourceLifecycle

---

provider^Optional

public readonly provider: TerraformProvider;

• Type: cdktf.TerraformProvider

---

provisioners^Optional

public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];

• Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

---

backupRestore^Required

public readonly backupRestore: DatabaseClusterBackupRestoreOutputReference;

• Type: DatabaseClusterBackupRestoreOutputReference

---

database^Required

public readonly database: string;

• Type: string

---

host^Required

public readonly host: string;

• Type: string

---

maintenanceWindow^Required

public readonly maintenanceWindow: DatabaseClusterMaintenanceWindowList;

• Type: DatabaseClusterMaintenanceWindowList

---

password^Required

public readonly password: string;

• Type: string

---

port^Required

public readonly port: number;

• Type: number

---

privateHost^Required

public readonly privateHost: string;

• Type: string

---

privateUri^Required

public readonly privateUri: string;

• Type: string

---

timeouts^Required

public readonly timeouts: DatabaseClusterTimeoutsOutputReference;

• Type: DatabaseClusterTimeoutsOutputReference

---

uiDatabase^Required

public readonly uiDatabase: string;

• Type: string

---

uiHost^Required

public readonly uiHost: string;

• Type: string

---

uiPassword^Required

public readonly uiPassword: string;

• Type: string

---

uiPort^Required

public readonly uiPort: number;

• Type: number

---

uiUri^Required

public readonly uiUri: string;

• Type: string

---

uiUser^Required

public readonly uiUser: string;

• Type: string

---

uri^Required

public readonly uri: string;

• Type: string

---

urn^Required

public readonly urn: string;

• Type: string

---

user^Required

public readonly user: string;

• Type: string

---

backupRestoreInput^Optional

public readonly backupRestoreInput: DatabaseClusterBackupRestore;

• Type: DatabaseClusterBackupRestore

---

engineInput^Optional

public readonly engineInput: string;

• Type: string

---

evictionPolicyInput^Optional

public readonly evictionPolicyInput: string;

• Type: string

---

idInput^Optional

public readonly idInput: string;

• Type: string

---

maintenanceWindowInput^Optional

public readonly maintenanceWindowInput: IResolvable | DatabaseClusterMaintenanceWindow[];

• Type: cdktf.IResolvable | DatabaseClusterMaintenanceWindow[]

---

nameInput^Optional

public readonly nameInput: string;

• Type: string

---

nodeCountInput^Optional

public readonly nodeCountInput: number;

• Type: number

---

privateNetworkUuidInput^Optional

public readonly privateNetworkUuidInput: string;

• Type: string

---

projectIdInput^Optional

public readonly projectIdInput: string;

• Type: string

---

regionInput^Optional

public readonly regionInput: string;

• Type: string

---

sizeInput^Optional

public readonly sizeInput: string;

• Type: string

---

sqlModeInput^Optional

public readonly sqlModeInput: string;

• Type: string

---

storageSizeMibInput^Optional

public readonly storageSizeMibInput: string;

• Type: string

---

tagsInput^Optional

public readonly tagsInput: string[];

• Type: string[]

---

timeoutsInput^Optional

public readonly timeoutsInput: IResolvable | DatabaseClusterTimeouts;

• Type: cdktf.IResolvable | DatabaseClusterTimeouts

---

versionInput^Optional

public readonly versionInput: string;

• Type: string

---

engine^Required

public readonly engine: string;

• Type: string

---

evictionPolicy^Required

public readonly evictionPolicy: string;

• Type: string

---

id^Required

public readonly id: string;

• Type: string

---

name^Required

public readonly name: string;

• Type: string

---

nodeCount^Required

public readonly nodeCount: number;

• Type: number

---

privateNetworkUuid^Required

public readonly privateNetworkUuid: string;

• Type: string

---

projectId^Required

public readonly projectId: string;

• Type: string

---

region^Required

public readonly region: string;

• Type: string

---

size^Required

public readonly size: string;

• Type: string

---

sqlMode^Required

public readonly sqlMode: string;

• Type: string

---

storageSizeMib^Required

public readonly storageSizeMib: string;

• Type: string

---

tags^Required

public readonly tags: string[];

• Type: string[]

---

version^Required

public readonly version: string;

• Type: string

---

Constants

Name	Type	Description
tfResourceType	string	No description.

---

tfResourceType^Required

public readonly tfResourceType: string;

• Type: string

---

Structs

DatabaseClusterBackupRestore

Initializer

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

const databaseClusterBackupRestore: databaseCluster.DatabaseClusterBackupRestore = { ... }

Properties

Name	Type	Description
databaseName	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/database_cluster#database_name DatabaseCluster#database_name}.
backupCreatedAt	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/database_cluster#backup_created_at DatabaseCluster#backup_created_at}.

---

databaseName^Required

public readonly databaseName: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/database_cluster#database_name DatabaseCluster#database_name}.

---

backupCreatedAt^Optional

public readonly backupCreatedAt: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/database_cluster#backup_created_at DatabaseCluster#backup_created_at}.

---

DatabaseClusterConfig

Initializer

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

const databaseClusterConfig: databaseCluster.DatabaseClusterConfig = { ... }

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.
engine	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/database_cluster#engine DatabaseCluster#engine}.
name	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/database_cluster#name DatabaseCluster#name}.
nodeCount	number	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/database_cluster#node_count DatabaseCluster#node_count}.
region	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/database_cluster#region DatabaseCluster#region}.
size	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/database_cluster#size DatabaseCluster#size}.
backupRestore	DatabaseClusterBackupRestore	backup_restore block.
evictionPolicy	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/database_cluster#eviction_policy DatabaseCluster#eviction_policy}.
id	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/database_cluster#id DatabaseCluster#id}.
maintenanceWindow	cdktf.IResolvable | DatabaseClusterMaintenanceWindow[]	maintenance_window block.
privateNetworkUuid	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/database_cluster#private_network_uuid DatabaseCluster#private_network_uuid}.
projectId	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/database_cluster#project_id DatabaseCluster#project_id}.
sqlMode	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/database_cluster#sql_mode DatabaseCluster#sql_mode}.
storageSizeMib	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/database_cluster#storage_size_mib DatabaseCluster#storage_size_mib}.
tags	string[]	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/database_cluster#tags DatabaseCluster#tags}.
timeouts	DatabaseClusterTimeouts	timeouts block.
version	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/database_cluster#version DatabaseCluster#version}.

---

connection^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

• Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

---

count^Optional

public readonly count: number | TerraformCount;

• Type: number | cdktf.TerraformCount

---

dependsOn^Optional

public readonly dependsOn: ITerraformDependable[];

• Type: cdktf.ITerraformDependable[]

---

forEach^Optional

public readonly forEach: ITerraformIterator;

• Type: cdktf.ITerraformIterator

---

lifecycle^Optional

public readonly lifecycle: TerraformResourceLifecycle;

• Type: cdktf.TerraformResourceLifecycle

---

provider^Optional

public readonly provider: TerraformProvider;

• Type: cdktf.TerraformProvider

---

provisioners^Optional

public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];

• Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

---

engine^Required

public readonly engine: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/database_cluster#engine DatabaseCluster#engine}.

---

name^Required

public readonly name: string;

• Type: string

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

---

nodeCount^Required

public readonly nodeCount: number;

• Type: number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/database_cluster#node_count DatabaseCluster#node_count}.

---

region^Required

public readonly region: string;

• Type: string

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

---

size^Required

public readonly size: string;

• Type: string

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

---

backupRestore^Optional

public readonly backupRestore: DatabaseClusterBackupRestore;

• Type: DatabaseClusterBackupRestore

backup_restore block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/database_cluster#backup_restore DatabaseCluster#backup_restore}

---

evictionPolicy^Optional

public readonly evictionPolicy: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/database_cluster#eviction_policy DatabaseCluster#eviction_policy}.

---

id^Optional

public readonly id: string;

• Type: string

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

---

maintenanceWindow^Optional

public readonly maintenanceWindow: IResolvable | DatabaseClusterMaintenanceWindow[];

• Type: cdktf.IResolvable | DatabaseClusterMaintenanceWindow[]

maintenance_window block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/database_cluster#maintenance_window DatabaseCluster#maintenance_window}

---

privateNetworkUuid^Optional

public readonly privateNetworkUuid: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/database_cluster#private_network_uuid DatabaseCluster#private_network_uuid}.

---

projectId^Optional

public readonly projectId: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/database_cluster#project_id DatabaseCluster#project_id}.

---

sqlMode^Optional

public readonly sqlMode: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/database_cluster#sql_mode DatabaseCluster#sql_mode}.

---

storageSizeMib^Optional

public readonly storageSizeMib: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/database_cluster#storage_size_mib DatabaseCluster#storage_size_mib}.

---

tags^Optional

public readonly tags: string[];

• Type: string[]

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

---

timeouts^Optional

public readonly timeouts: DatabaseClusterTimeouts;

• Type: DatabaseClusterTimeouts

timeouts block.

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

---

version^Optional

public readonly version: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/database_cluster#version DatabaseCluster#version}.

---

DatabaseClusterMaintenanceWindow

Initializer

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

const databaseClusterMaintenanceWindow: databaseCluster.DatabaseClusterMaintenanceWindow = { ... }

Properties

Name	Type	Description
day	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/database_cluster#day DatabaseCluster#day}.
hour	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/database_cluster#hour DatabaseCluster#hour}.

---

day^Required

public readonly day: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/database_cluster#day DatabaseCluster#day}.

---

hour^Required

public readonly hour: string;

• Type: string

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

---

DatabaseClusterTimeouts

Initializer

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

const databaseClusterTimeouts: databaseCluster.DatabaseClusterTimeouts = { ... }

Properties

Name	Type	Description
create	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.46.1/docs/resources/database_cluster#create DatabaseCluster#create}.

---

create^Optional

public readonly create: string;

• Type: string

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

---

Classes

DatabaseClusterBackupRestoreOutputReference

Initializers

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

new databaseCluster.DatabaseClusterBackupRestoreOutputReference(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.

---

terraformResource^Required

• Type: cdktf.IInterpolatingParent

The parent resource.

---

terraformAttribute^Required

• 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.
resetBackupCreatedAt	No description.

---

computeFqn

public computeFqn(): string

getAnyMapAttribute

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

terraformAttribute^Required

• Type: string

---

getBooleanAttribute

public getBooleanAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

getBooleanMapAttribute

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

terraformAttribute^Required

• Type: string

---

getListAttribute

public getListAttribute(terraformAttribute: string): string[]

terraformAttribute^Required

• Type: string

---

getNumberAttribute

public getNumberAttribute(terraformAttribute: string): number

terraformAttribute^Required

• Type: string

---

getNumberListAttribute

public getNumberListAttribute(terraformAttribute: string): number[]

terraformAttribute^Required

• Type: string

---

getNumberMapAttribute

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

terraformAttribute^Required

• Type: string

---

getStringAttribute

public getStringAttribute(terraformAttribute: string): string

terraformAttribute^Required

• Type: string

---

getStringMapAttribute

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

terraformAttribute^Required

• Type: string

---

interpolationForAttribute

public interpolationForAttribute(property: string): IResolvable

property^Required

• Type: string

---

resolve

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_context^Required

• Type: cdktf.IResolveContext

---

toString

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

resetBackupCreatedAt

public resetBackupCreatedAt(): 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.
backupCreatedAtInput	string	No description.
databaseNameInput	string	No description.
backupCreatedAt	string	No description.
databaseName	string	No description.
internalValue	DatabaseClusterBackupRestore	No description.

---

creationStack^Required

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.

---

fqn^Required

public readonly fqn: string;

• Type: string

---

backupCreatedAtInput^Optional

public readonly backupCreatedAtInput: string;

• Type: string

---

databaseNameInput^Optional

public readonly databaseNameInput: string;

• Type: string

---

backupCreatedAt^Required

public readonly backupCreatedAt: string;

• Type: string

---

databaseName^Required

public readonly databaseName: string;

• Type: string

---

internalValue^Optional

public readonly internalValue: DatabaseClusterBackupRestore;

• Type: DatabaseClusterBackupRestore

---

DatabaseClusterMaintenanceWindowList

Initializers

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

new databaseCluster.DatabaseClusterMaintenanceWindowList(terraformResource: IInterpolatingParent, terraformAttribute: string, wrapsSet: boolean)

Name	Type	Description
terraformResource	cdktf.IInterpolatingParent	The parent resource.
terraformAttribute	string	The attribute on the parent resource this class is referencing.
wrapsSet	boolean	whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

---

terraformResource^Required

• Type: cdktf.IInterpolatingParent

The parent resource.

---

terraformAttribute^Required

• Type: string

The attribute on the parent resource this class is referencing.

---

wrapsSet^Required

• Type: boolean

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

---

Methods

Name	Description
allWithMapKey	Creating an iterator for this complex list.
computeFqn	No description.
resolve	Produce the Token's value at resolution time.
toString	Return a string representation of this resolvable object.
get	No description.

---

allWithMapKey

public allWithMapKey(mapKeyAttributeName: string): DynamicListTerraformIterator

Creating an iterator for this complex list.

The list will be converted into a map with the mapKeyAttributeName as the key.

mapKeyAttributeName^Required

• Type: string

---

computeFqn

public computeFqn(): string

resolve

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_context^Required

• Type: cdktf.IResolveContext

---

toString

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

get

public get(index: number): DatabaseClusterMaintenanceWindowOutputReference

index^Required

• Type: number

the index of the item to return.

---

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.
internalValue	cdktf.IResolvable | DatabaseClusterMaintenanceWindow[]	No description.

---

creationStack^Required

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.

---

fqn^Required

public readonly fqn: string;

• Type: string

---

internalValue^Optional

public readonly internalValue: IResolvable | DatabaseClusterMaintenanceWindow[];

• Type: cdktf.IResolvable | DatabaseClusterMaintenanceWindow[]

---

DatabaseClusterMaintenanceWindowOutputReference

Initializers

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

new databaseCluster.DatabaseClusterMaintenanceWindowOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string, complexObjectIndex: number, complexObjectIsFromSet: boolean)

Name	Type	Description
terraformResource	cdktf.IInterpolatingParent	The parent resource.
terraformAttribute	string	The attribute on the parent resource this class is referencing.
complexObjectIndex	number	the index of this item in the list.
complexObjectIsFromSet	boolean	whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

---

terraformResource^Required

• Type: cdktf.IInterpolatingParent

The parent resource.

---

terraformAttribute^Required

• Type: string

The attribute on the parent resource this class is referencing.

---

complexObjectIndex^Required

• Type: number

the index of this item in the list.

---

complexObjectIsFromSet^Required

• Type: boolean

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

---

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.

---

computeFqn

public computeFqn(): string

getAnyMapAttribute

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

terraformAttribute^Required

• Type: string

---

getBooleanAttribute

public getBooleanAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

getBooleanMapAttribute

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

terraformAttribute^Required

• Type: string

---

getListAttribute

public getListAttribute(terraformAttribute: string): string[]

terraformAttribute^Required

• Type: string

---

getNumberAttribute

public getNumberAttribute(terraformAttribute: string): number

terraformAttribute^Required

• Type: string

---

getNumberListAttribute

public getNumberListAttribute(terraformAttribute: string): number[]

terraformAttribute^Required

• Type: string

---

getNumberMapAttribute

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

terraformAttribute^Required

• Type: string

---

getStringAttribute

public getStringAttribute(terraformAttribute: string): string

terraformAttribute^Required

• Type: string

---

getStringMapAttribute

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

terraformAttribute^Required

• Type: string

---

interpolationForAttribute

public interpolationForAttribute(property: string): IResolvable

property^Required

• Type: string

---

resolve

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_context^Required

• Type: cdktf.IResolveContext

---

toString

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

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.
dayInput	string	No description.
hourInput	string	No description.
day	string	No description.
hour	string	No description.
internalValue	cdktf.IResolvable | DatabaseClusterMaintenanceWindow	No description.

---

creationStack^Required

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.

---

fqn^Required

public readonly fqn: string;

• Type: string

---

dayInput^Optional

public readonly dayInput: string;

• Type: string

---

hourInput^Optional

public readonly hourInput: string;

• Type: string

---

day^Required

public readonly day: string;

• Type: string

---

hour^Required

public readonly hour: string;

• Type: string

---

internalValue^Optional

public readonly internalValue: IResolvable | DatabaseClusterMaintenanceWindow;

• Type: cdktf.IResolvable | DatabaseClusterMaintenanceWindow

---

DatabaseClusterTimeoutsOutputReference

Initializers

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

new databaseCluster.DatabaseClusterTimeoutsOutputReference(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.

---

terraformResource^Required

• Type: cdktf.IInterpolatingParent

The parent resource.

---

terraformAttribute^Required

• 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.

---

computeFqn

public computeFqn(): string

getAnyMapAttribute

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

terraformAttribute^Required

• Type: string

---

getBooleanAttribute

public getBooleanAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

getBooleanMapAttribute

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

terraformAttribute^Required

• Type: string

---

getListAttribute

public getListAttribute(terraformAttribute: string): string[]

terraformAttribute^Required

• Type: string

---

getNumberAttribute

public getNumberAttribute(terraformAttribute: string): number

terraformAttribute^Required

• Type: string

---

getNumberListAttribute

public getNumberListAttribute(terraformAttribute: string): number[]

terraformAttribute^Required

• Type: string

---

getNumberMapAttribute

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

terraformAttribute^Required

• Type: string

---

getStringAttribute

public getStringAttribute(terraformAttribute: string): string

terraformAttribute^Required

• Type: string

---

getStringMapAttribute

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

terraformAttribute^Required

• Type: string

---

interpolationForAttribute

public interpolationForAttribute(property: string): IResolvable

property^Required

• Type: string

---

resolve

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_context^Required

• Type: cdktf.IResolveContext

---

toString

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

resetCreate

public resetCreate(): 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.
create	string	No description.
internalValue	cdktf.IResolvable | DatabaseClusterTimeouts	No description.

---

creationStack^Required

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.

---

fqn^Required

public readonly fqn: string;

• Type: string

---

createInput^Optional

public readonly createInput: string;

• Type: string

---

create^Required

public readonly create: string;

• Type: string

---

internalValue^Optional

public readonly internalValue: IResolvable | DatabaseClusterTimeouts;

• Type: cdktf.IResolvable | DatabaseClusterTimeouts

---