Skip to content

Files

1200 lines (751 loc) · 48.1 KB
·

databaseReplica.csharp.md

File metadata and controls

1200 lines (751 loc) · 48.1 KB
·

databaseReplica Submodule

Constructs

DatabaseReplica

Represents a {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.47.0/docs/resources/database_replica digitalocean_database_replica}.

Initializers

using HashiCorp.Cdktf.Providers.Digitalocean;

new DatabaseReplica(Construct Scope, string Id, DatabaseReplicaConfig Config);
Name Type Description
Scope Constructs.Construct The scope in which to define this construct.
Id string The scoped construct ID.
Config DatabaseReplicaConfig 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".
ResetId No description.
ResetPrivateNetworkUuid No description.
ResetRegion No description.
ResetSize No description.
ResetStorageSizeMib No description.
ResetTags No description.

ToString
private string ToString()

Returns a string representation of this construct.

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

ValueRequired
  • Type: object

OverrideLogicalId
private void OverrideLogicalId(string NewLogicalId)

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

NewLogicalIdRequired
  • Type: string

The new logical ID to use for this stack element.


ResetOverrideLogicalId
private void ResetOverrideLogicalId()

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

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

Adds this resource to the terraform JSON output.

AddMoveTarget
private void AddMoveTarget(string MoveTarget)

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
private System.Collections.Generic.IDictionary<string, object> GetAnyMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

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

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

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

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

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

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

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

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

HasResourceMove
private object HasResourceMove()
ImportFrom
private void ImportFrom(string Id, TerraformProvider Provider = null)
IdRequired
  • Type: string

ProviderOptional
  • Type: HashiCorp.Cdktf.TerraformProvider

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

MoveFromId
private void MoveFromId(string Id)

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
private void MoveTo(string MoveTarget, object Index = null)

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: object

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


MoveToId
private void MoveToId(string Id)

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


ResetId
private void ResetId()
ResetPrivateNetworkUuid
private void ResetPrivateNetworkUuid()
ResetRegion
private void ResetRegion()
ResetSize
private void ResetSize()
ResetStorageSizeMib
private void ResetStorageSizeMib()
ResetTags
private void ResetTags()

Static Functions

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

IsConstruct
using HashiCorp.Cdktf.Providers.Digitalocean;

DatabaseReplica.IsConstruct(object X);

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

XRequired
  • Type: object

Any object.


IsTerraformElement
using HashiCorp.Cdktf.Providers.Digitalocean;

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

IsTerraformResource
using HashiCorp.Cdktf.Providers.Digitalocean;

DatabaseReplica.IsTerraformResource(object X);
XRequired
  • Type: object

GenerateConfigForImport
using HashiCorp.Cdktf.Providers.Digitalocean;

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

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


ImportFromIdRequired
  • Type: string

The id of the existing DatabaseReplica that should be imported.

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


ProviderOptional
  • Type: HashiCorp.Cdktf.TerraformProvider

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


Properties

Name Type Description
Node Constructs.Node The tree node.
CdktfStack HashiCorp.Cdktf.TerraformStack No description.
Fqn string No description.
FriendlyUniqueId string No description.
TerraformMetaArguments System.Collections.Generic.IDictionary<string, object> No description.
TerraformResourceType string No description.
TerraformGeneratorMetadata HashiCorp.Cdktf.TerraformProviderGeneratorMetadata No description.
Connection object No description.
Count object No description.
DependsOn string[] No description.
ForEach HashiCorp.Cdktf.ITerraformIterator No description.
Lifecycle HashiCorp.Cdktf.TerraformResourceLifecycle No description.
Provider HashiCorp.Cdktf.TerraformProvider No description.
Provisioners object[] No description.
Database string No description.
Host string No description.
Password string No description.
Port double No description.
PrivateHost string No description.
PrivateUri string No description.
Uri string No description.
User string No description.
Uuid string No description.
ClusterIdInput string No description.
IdInput string No description.
NameInput string No description.
PrivateNetworkUuidInput string No description.
RegionInput string No description.
SizeInput string No description.
StorageSizeMibInput string No description.
TagsInput string[] No description.
ClusterId string No description.
Id string No description.
Name string No description.
PrivateNetworkUuid string No description.
Region string No description.
Size string No description.
StorageSizeMib string No description.
Tags string[] No description.

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

The tree node.


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

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

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

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

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

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

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

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

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

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

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

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

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

DatabaseRequired
public string Database { get; }
  • Type: string

HostRequired
public string Host { get; }
  • Type: string

PasswordRequired
public string Password { get; }
  • Type: string

PortRequired
public double Port { get; }
  • Type: double

PrivateHostRequired
public string PrivateHost { get; }
  • Type: string

PrivateUriRequired
public string PrivateUri { get; }
  • Type: string

UriRequired
public string Uri { get; }
  • Type: string

UserRequired
public string User { get; }
  • Type: string

UuidRequired
public string Uuid { get; }
  • Type: string

ClusterIdInputOptional
public string ClusterIdInput { get; }
  • Type: string

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

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

PrivateNetworkUuidInputOptional
public string PrivateNetworkUuidInput { get; }
  • Type: string

RegionInputOptional
public string RegionInput { get; }
  • Type: string

SizeInputOptional
public string SizeInput { get; }
  • Type: string

StorageSizeMibInputOptional
public string StorageSizeMibInput { get; }
  • Type: string

TagsInputOptional
public string[] TagsInput { get; }
  • Type: string[]

ClusterIdRequired
public string ClusterId { get; }
  • Type: string

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

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

PrivateNetworkUuidRequired
public string PrivateNetworkUuid { get; }
  • Type: string

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

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

StorageSizeMibRequired
public string StorageSizeMib { get; }
  • Type: string

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

Constants

Name Type Description
TfResourceType string No description.

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

Structs

DatabaseReplicaConfig

Initializer

using HashiCorp.Cdktf.Providers.Digitalocean;

new DatabaseReplicaConfig {
    object Connection = null,
    object Count = null,
    ITerraformDependable[] DependsOn = null,
    ITerraformIterator ForEach = null,
    TerraformResourceLifecycle Lifecycle = null,
    TerraformProvider Provider = null,
    object[] Provisioners = null,
    string ClusterId,
    string Name,
    string Id = null,
    string PrivateNetworkUuid = null,
    string Region = null,
    string Size = null,
    string StorageSizeMib = null,
    string[] Tags = null
};

Properties

Name Type Description
Connection object No description.
Count object No description.
DependsOn HashiCorp.Cdktf.ITerraformDependable[] No description.
ForEach HashiCorp.Cdktf.ITerraformIterator No description.
Lifecycle HashiCorp.Cdktf.TerraformResourceLifecycle No description.
Provider HashiCorp.Cdktf.TerraformProvider No description.
Provisioners object[] No description.
ClusterId string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.47.0/docs/resources/database_replica#cluster_id DatabaseReplica#cluster_id}.
Name string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.47.0/docs/resources/database_replica#name DatabaseReplica#name}.
Id string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.47.0/docs/resources/database_replica#id DatabaseReplica#id}.
PrivateNetworkUuid string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.47.0/docs/resources/database_replica#private_network_uuid DatabaseReplica#private_network_uuid}.
Region string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.47.0/docs/resources/database_replica#region DatabaseReplica#region}.
Size string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.47.0/docs/resources/database_replica#size DatabaseReplica#size}.
StorageSizeMib string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.47.0/docs/resources/database_replica#storage_size_mib DatabaseReplica#storage_size_mib}.
Tags string[] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.47.0/docs/resources/database_replica#tags DatabaseReplica#tags}.

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

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

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

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

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

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

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

ClusterIdRequired
public string ClusterId { get; set; }
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.47.0/docs/resources/database_replica#cluster_id DatabaseReplica#cluster_id}.


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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.47.0/docs/resources/database_replica#name DatabaseReplica#name}.


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

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


PrivateNetworkUuidOptional
public string PrivateNetworkUuid { get; set; }
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.47.0/docs/resources/database_replica#private_network_uuid DatabaseReplica#private_network_uuid}.


RegionOptional
public string Region { get; set; }
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.47.0/docs/resources/database_replica#region DatabaseReplica#region}.


SizeOptional
public string Size { get; set; }
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.47.0/docs/resources/database_replica#size DatabaseReplica#size}.


StorageSizeMibOptional
public string StorageSizeMib { get; set; }
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.47.0/docs/resources/database_replica#storage_size_mib DatabaseReplica#storage_size_mib}.


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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/digitalocean/digitalocean/2.47.0/docs/resources/database_replica#tags DatabaseReplica#tags}.