Skip to content

Latest commit

 

History

History
2808 lines (1746 loc) · 121 KB

databaseCluster.go.md

File metadata and controls

2808 lines (1746 loc) · 121 KB
Raw

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 "github.com/cdktf/cdktf-provider-digitalocean-go/digitalocean/v11/databasecluster"

databasecluster.NewDatabaseCluster(scope Construct, id *string, config DatabaseClusterConfig) DatabaseCluster
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 DatabaseClusterConfig 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

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".
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 
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{}
ToMetadata 
func ToMetadata() interface{}
ToTerraform 
func ToTerraform() interface{}

Adds this resource to the terraform JSON output.

AddMoveTarget 
func AddMoveTarget(moveTarget *string)

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 
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
HasResourceMove 
func HasResourceMove() interface{}
ImportFrom 
func ImportFrom(id *string, provider TerraformProvider)
idRequired
  • Type: *string
providerOptional
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider
InterpolationForAttribute 
func InterpolationForAttribute(terraformAttribute *string) IResolvable
terraformAttributeRequired
  • Type: *string
MoveFromId 
func MoveFromId(id *string)

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 
func MoveTo(moveTarget *string, index interface{})

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

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

MoveToId 
func MoveToId(id *string)

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

PutBackupRestore 
func PutBackupRestore(value DatabaseClusterBackupRestore)
valueRequired
PutMaintenanceWindow 
func PutMaintenanceWindow(value interface{})
valueRequired
  • Type: interface{}
PutTimeouts 
func PutTimeouts(value DatabaseClusterTimeouts)
valueRequired
ResetBackupRestore 
func ResetBackupRestore()
ResetEvictionPolicy 
func ResetEvictionPolicy()
ResetId 
func ResetId()
ResetMaintenanceWindow 
func ResetMaintenanceWindow()
ResetPrivateNetworkUuid 
func ResetPrivateNetworkUuid()
ResetProjectId 
func ResetProjectId()
ResetSqlMode 
func ResetSqlMode()
ResetStorageSizeMib 
func ResetStorageSizeMib()
ResetTags 
func ResetTags()
ResetTimeouts 
func ResetTimeouts()
ResetVersion 
func ResetVersion()

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 "github.com/cdktf/cdktf-provider-digitalocean-go/digitalocean/v11/databasecluster"

databasecluster.DatabaseCluster_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/databasecluster"

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

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

databasecluster.DatabaseCluster_GenerateConfigForImport(scope Construct, importToId *string, importFromId *string, provider TerraformProvider) ImportableResource

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

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

providerOptional
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider

? Optional instance of the provider where the DatabaseCluster 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.
Connection interface{} 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.
Provisioners *[]interface{} No description.
BackupRestore DatabaseClusterBackupRestoreOutputReference No description.
Database *string No description.
Host *string No description.
MaintenanceWindow DatabaseClusterMaintenanceWindowList No description.
Password *string No description.
Port *f64 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 *f64 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 interface{} No description.
NameInput *string No description.
NodeCountInput *f64 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 interface{} No description.
VersionInput *string No description.
Engine *string No description.
EvictionPolicy *string No description.
Id *string No description.
Name *string No description.
NodeCount *f64 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.
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
ConnectionOptional 
func Connection() interface{}
  • Type: interface{}
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
ProvisionersOptional 
func Provisioners() *[]interface{}
  • Type: *[]interface{}
BackupRestoreRequired 
func BackupRestore() DatabaseClusterBackupRestoreOutputReference
DatabaseRequired 
func Database() *string
  • Type: *string
HostRequired 
func Host() *string
  • Type: *string
MaintenanceWindowRequired 
func MaintenanceWindow() DatabaseClusterMaintenanceWindowList
PasswordRequired 
func Password() *string
  • Type: *string
PortRequired 
func Port() *f64
  • Type: *f64
PrivateHostRequired 
func PrivateHost() *string
  • Type: *string
PrivateUriRequired 
func PrivateUri() *string
  • Type: *string
TimeoutsRequired 
func Timeouts() DatabaseClusterTimeoutsOutputReference
UiDatabaseRequired 
func UiDatabase() *string
  • Type: *string
UiHostRequired 
func UiHost() *string
  • Type: *string
UiPasswordRequired 
func UiPassword() *string
  • Type: *string
UiPortRequired 
func UiPort() *f64
  • Type: *f64
UiUriRequired 
func UiUri() *string
  • Type: *string
UiUserRequired 
func UiUser() *string
  • Type: *string
UriRequired 
func Uri() *string
  • Type: *string
UrnRequired 
func Urn() *string
  • Type: *string
UserRequired 
func User() *string
  • Type: *string
BackupRestoreInputOptional 
func BackupRestoreInput() DatabaseClusterBackupRestore
EngineInputOptional 
func EngineInput() *string
  • Type: *string
EvictionPolicyInputOptional 
func EvictionPolicyInput() *string
  • Type: *string
IdInputOptional 
func IdInput() *string
  • Type: *string
MaintenanceWindowInputOptional 
func MaintenanceWindowInput() interface{}
  • Type: interface{}
NameInputOptional 
func NameInput() *string
  • Type: *string
NodeCountInputOptional 
func NodeCountInput() *f64
  • Type: *f64
PrivateNetworkUuidInputOptional 
func PrivateNetworkUuidInput() *string
  • Type: *string
ProjectIdInputOptional 
func ProjectIdInput() *string
  • Type: *string
RegionInputOptional 
func RegionInput() *string
  • Type: *string
SizeInputOptional 
func SizeInput() *string
  • Type: *string
SqlModeInputOptional 
func SqlModeInput() *string
  • Type: *string
StorageSizeMibInputOptional 
func StorageSizeMibInput() *string
  • Type: *string
TagsInputOptional 
func TagsInput() *[]*string
  • Type: *[]*string
TimeoutsInputOptional 
func TimeoutsInput() interface{}
  • Type: interface{}
VersionInputOptional 
func VersionInput() *string
  • Type: *string
EngineRequired 
func Engine() *string
  • Type: *string
EvictionPolicyRequired 
func EvictionPolicy() *string
  • Type: *string
IdRequired 
func Id() *string
  • Type: *string
NameRequired 
func Name() *string
  • Type: *string
NodeCountRequired 
func NodeCount() *f64
  • Type: *f64
PrivateNetworkUuidRequired 
func PrivateNetworkUuid() *string
  • Type: *string
ProjectIdRequired 
func ProjectId() *string
  • Type: *string
RegionRequired 
func Region() *string
  • Type: *string
SizeRequired 
func Size() *string
  • Type: *string
SqlModeRequired 
func SqlMode() *string
  • Type: *string
StorageSizeMibRequired 
func StorageSizeMib() *string
  • Type: *string
TagsRequired 
func Tags() *[]*string
  • Type: *[]*string
VersionRequired 
func Version() *string
  • Type: *string

Constants

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

Structs

DatabaseClusterBackupRestore

Initializer 

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

&databasecluster.DatabaseClusterBackupRestore {
	DatabaseName: *string,
	BackupCreatedAt: *string,
}

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}.
DatabaseNameRequired 
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}.

BackupCreatedAtOptional 
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 "github.com/cdktf/cdktf-provider-digitalocean-go/digitalocean/v11/databasecluster"

&databasecluster.DatabaseClusterConfig {
	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{},
	Engine: *string,
	Name: *string,
	NodeCount: *f64,
	Region: *string,
	Size: *string,
	BackupRestore: github.com/cdktf/cdktf-provider-digitalocean-go/digitalocean/v11.databaseCluster.DatabaseClusterBackupRestore,
	EvictionPolicy: *string,
	Id: *string,
	MaintenanceWindow: interface{},
	PrivateNetworkUuid: *string,
	ProjectId: *string,
	SqlMode: *string,
	StorageSizeMib: *string,
	Tags: *[]*string,
	Timeouts: github.com/cdktf/cdktf-provider-digitalocean-go/digitalocean/v11.databaseCluster.DatabaseClusterTimeouts,
	Version: *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.
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 *f64 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 interface{} 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}.
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{}
EngineRequired 
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}.

NameRequired 
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}.

NodeCountRequired 
NodeCount *f64
  • Type: *f64

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

RegionRequired 
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}.

SizeRequired 
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}.

BackupRestoreOptional 
BackupRestore 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}

EvictionPolicyOptional 
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}.

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

MaintenanceWindowOptional 
MaintenanceWindow interface{}
  • Type: interface{}

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}

PrivateNetworkUuidOptional 
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}.

ProjectIdOptional 
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}.

SqlModeOptional 
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}.

StorageSizeMibOptional 
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}.

TagsOptional 
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}.

TimeoutsOptional 
Timeouts 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}

VersionOptional 
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 "github.com/cdktf/cdktf-provider-digitalocean-go/digitalocean/v11/databasecluster"

&databasecluster.DatabaseClusterMaintenanceWindow {
	Day: *string,
	Hour: *string,
}

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}.
DayRequired 
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}.

HourRequired 
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 "github.com/cdktf/cdktf-provider-digitalocean-go/digitalocean/v11/databasecluster"

&databasecluster.DatabaseClusterTimeouts {
	Create: *string,
}

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}.
CreateOptional 
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 "github.com/cdktf/cdktf-provider-digitalocean-go/digitalocean/v11/databasecluster"

databasecluster.NewDatabaseClusterBackupRestoreOutputReference(terraformResource IInterpolatingParent, terraformAttribute *string) DatabaseClusterBackupRestoreOutputReference
Name Type Description
terraformResource github.com/hashicorp/terraform-cdk-go/cdktf.IInterpolatingParent The parent resource.
terraformAttribute *string The attribute on the parent resource this class is referencing.
terraformResourceRequired
  • Type: github.com/hashicorp/terraform-cdk-go/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.
ResetBackupCreatedAt No description.
ComputeFqn 
func ComputeFqn() *string
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(property *string) IResolvable
propertyRequired
  • Type: *string
Resolve 
func Resolve(_context IResolveContext) interface{}

Produce the Token's value at resolution time.

_contextRequired
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.IResolveContext
ToString 
func ToString() *string

Return a string representation of this resolvable object.

Returns a reversible string representation.

ResetBackupCreatedAt 
func ResetBackupCreatedAt()

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.
CreationStackRequired 
func 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 
func Fqn() *string
  • Type: *string
BackupCreatedAtInputOptional 
func BackupCreatedAtInput() *string
  • Type: *string
DatabaseNameInputOptional 
func DatabaseNameInput() *string
  • Type: *string
BackupCreatedAtRequired 
func BackupCreatedAt() *string
  • Type: *string
DatabaseNameRequired 
func DatabaseName() *string
  • Type: *string
InternalValueOptional 
func InternalValue() DatabaseClusterBackupRestore

DatabaseClusterMaintenanceWindowList

Initializers 

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

databasecluster.NewDatabaseClusterMaintenanceWindowList(terraformResource IInterpolatingParent, terraformAttribute *string, wrapsSet *bool) DatabaseClusterMaintenanceWindowList
Name Type Description
terraformResource github.com/hashicorp/terraform-cdk-go/cdktf.IInterpolatingParent The parent resource.
terraformAttribute *string The attribute on the parent resource this class is referencing.
wrapsSet *bool whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
terraformResourceRequired
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • Type: *string

The attribute on the parent resource this class is referencing.

wrapsSetRequired
  • Type: *bool

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

mapKeyAttributeNameRequired
  • Type: *string
ComputeFqn 
func ComputeFqn() *string
Resolve 
func Resolve(_context IResolveContext) interface{}

Produce the Token's value at resolution time.

_contextRequired
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.IResolveContext
ToString 
func ToString() *string

Return a string representation of this resolvable object.

Returns a reversible string representation.

Get 
func Get(index *f64) DatabaseClusterMaintenanceWindowOutputReference
indexRequired
  • Type: *f64

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 interface{} No description.
CreationStackRequired 
func 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 
func Fqn() *string
  • Type: *string
InternalValueOptional 
func InternalValue() interface{}
  • Type: interface{}

DatabaseClusterMaintenanceWindowOutputReference

Initializers 

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

databasecluster.NewDatabaseClusterMaintenanceWindowOutputReference(terraformResource IInterpolatingParent, terraformAttribute *string, complexObjectIndex *f64, complexObjectIsFromSet *bool) DatabaseClusterMaintenanceWindowOutputReference
Name Type Description
terraformResource github.com/hashicorp/terraform-cdk-go/cdktf.IInterpolatingParent The parent resource.
terraformAttribute *string The attribute on the parent resource this class is referencing.
complexObjectIndex *f64 the index of this item in the list.
complexObjectIsFromSet *bool whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
terraformResourceRequired
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • Type: *string

The attribute on the parent resource this class is referencing.

complexObjectIndexRequired
  • Type: *f64

the index of this item in the list.

complexObjectIsFromSetRequired
  • Type: *bool

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 
func ComputeFqn() *string
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(property *string) IResolvable
propertyRequired
  • Type: *string
Resolve 
func Resolve(_context IResolveContext) interface{}

Produce the Token's value at resolution time.

_contextRequired
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.IResolveContext
ToString 
func 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 interface{} No description.
CreationStackRequired 
func 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 
func Fqn() *string
  • Type: *string
DayInputOptional 
func DayInput() *string
  • Type: *string
HourInputOptional 
func HourInput() *string
  • Type: *string
DayRequired 
func Day() *string
  • Type: *string
HourRequired 
func Hour() *string
  • Type: *string
InternalValueOptional 
func InternalValue() interface{}
  • Type: interface{}

DatabaseClusterTimeoutsOutputReference

Initializers 

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

databasecluster.NewDatabaseClusterTimeoutsOutputReference(terraformResource IInterpolatingParent, terraformAttribute *string) DatabaseClusterTimeoutsOutputReference
Name Type Description
terraformResource github.com/hashicorp/terraform-cdk-go/cdktf.IInterpolatingParent The parent resource.
terraformAttribute *string The attribute on the parent resource this class is referencing.
terraformResourceRequired
  • Type: github.com/hashicorp/terraform-cdk-go/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.
ComputeFqn 
func ComputeFqn() *string
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(property *string) IResolvable
propertyRequired
  • Type: *string
Resolve 
func Resolve(_context IResolveContext) interface{}

Produce the Token's value at resolution time.

_contextRequired
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.IResolveContext
ToString 
func ToString() *string

Return a string representation of this resolvable object.

Returns a reversible string representation.

ResetCreate 
func ResetCreate()

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 interface{} No description.
CreationStackRequired 
func 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 
func Fqn() *string
  • Type: *string
CreateInputOptional 
func CreateInput() *string
  • Type: *string
CreateRequired 
func Create() *string
  • Type: *string
InternalValueOptional 
func InternalValue() interface{}
  • Type: interface{}