database.csharp.md

database Submodule

Constructs

Database

Represents a {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs/resources/database postgresql_database}.

Initializers

using HashiCorp.Cdktf.Providers.Postgresql;

new Database(Construct Scope, string Id, DatabaseConfig Config);

Name	Type	Description
Scope	Constructs.Construct	The scope in which to define this construct.
Id	string	The scoped construct ID.
Config	DatabaseConfig	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: DatabaseConfig

---

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".
ResetAllowConnections	No description.
ResetAlterObjectOwnership	No description.
ResetConnectionLimit	No description.
ResetEncoding	No description.
ResetId	No description.
ResetIsTemplate	No description.
ResetLcCollate	No description.
ResetLcCtype	No description.
ResetOwner	No description.
ResetTablespaceName	No description.
ResetTemplate	No description.

---

ToString

private string ToString()

Returns a string representation of this construct.

AddOverride

private void AddOverride(string Path, object Value)

Path^Required

• Type: string

---

Value^Required

• Type: object

---

OverrideLogicalId

private void OverrideLogicalId(string NewLogicalId)

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

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.

MoveTarget^Required

• Type: string

The string move target that will correspond to this resource.

---

GetAnyMapAttribute

private System.Collections.Generic.IDictionary<string, object> GetAnyMapAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetBooleanAttribute

private IResolvable GetBooleanAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetBooleanMapAttribute

private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetListAttribute

private string[] GetListAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetNumberAttribute

private double GetNumberAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetNumberListAttribute

private double[] GetNumberListAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetNumberMapAttribute

private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetStringAttribute

private string GetStringAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetStringMapAttribute

private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

HasResourceMove

private object HasResourceMove()

ImportFrom

private void ImportFrom(string Id, TerraformProvider Provider = null)

Id^Required

• Type: string

---

Provider^Optional

• Type: HashiCorp.Cdktf.TerraformProvider

---

InterpolationForAttribute

private IResolvable InterpolationForAttribute(string TerraformAttribute)

TerraformAttribute^Required

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

Id^Required

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

MoveTarget^Required

• Type: string

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

---

Index^Optional

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

Id^Required

• Type: string

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

---

ResetAllowConnections

private void ResetAllowConnections()

ResetAlterObjectOwnership

private void ResetAlterObjectOwnership()

ResetConnectionLimit

private void ResetConnectionLimit()

ResetEncoding

private void ResetEncoding()

ResetId

private void ResetId()

ResetIsTemplate

private void ResetIsTemplate()

ResetLcCollate

private void ResetLcCollate()

ResetLcCtype

private void ResetLcCtype()

ResetOwner

private void ResetOwner()

ResetTablespaceName

private void ResetTablespaceName()

ResetTemplate

private void ResetTemplate()

Static Functions

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

---

IsConstruct

using HashiCorp.Cdktf.Providers.Postgresql;

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

X^Required

• Type: object

Any object.

---

IsTerraformElement

using HashiCorp.Cdktf.Providers.Postgresql;

Database.IsTerraformElement(object X);

X^Required

• Type: object

---

IsTerraformResource

using HashiCorp.Cdktf.Providers.Postgresql;

Database.IsTerraformResource(object X);

X^Required

• Type: object

---

GenerateConfigForImport

using HashiCorp.Cdktf.Providers.Postgresql;

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

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

---

ImportFromId^Required

• Type: string

The id of the existing Database that should be imported.

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

---

Provider^Optional

• Type: HashiCorp.Cdktf.TerraformProvider

? Optional instance of the provider where the Database 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.
AllowConnectionsInput	object	No description.
AlterObjectOwnershipInput	object	No description.
ConnectionLimitInput	double	No description.
EncodingInput	string	No description.
IdInput	string	No description.
IsTemplateInput	object	No description.
LcCollateInput	string	No description.
LcCtypeInput	string	No description.
NameInput	string	No description.
OwnerInput	string	No description.
TablespaceNameInput	string	No description.
TemplateInput	string	No description.
AllowConnections	object	No description.
AlterObjectOwnership	object	No description.
ConnectionLimit	double	No description.
Encoding	string	No description.
Id	string	No description.
IsTemplate	object	No description.
LcCollate	string	No description.
LcCtype	string	No description.
Name	string	No description.
Owner	string	No description.
TablespaceName	string	No description.
Template	string	No description.

---

Node^Required

public Node Node { get; }

• Type: Constructs.Node

The tree node.

---

CdktfStack^Required

public TerraformStack CdktfStack { get; }

• Type: HashiCorp.Cdktf.TerraformStack

---

Fqn^Required

public string Fqn { get; }

• Type: string

---

FriendlyUniqueId^Required

public string FriendlyUniqueId { get; }

• Type: string

---

TerraformMetaArguments^Required

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

• Type: System.Collections.Generic.IDictionary<string, object>

---

TerraformResourceType^Required

public string TerraformResourceType { get; }

• Type: string

---

TerraformGeneratorMetadata^Optional

public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; }

• Type: HashiCorp.Cdktf.TerraformProviderGeneratorMetadata

---

Connection^Optional

public object Connection { get; }

• Type: object

---

Count^Optional

public object Count { get; }

• Type: object

---

DependsOn^Optional

public string[] DependsOn { get; }

• Type: string[]

---

ForEach^Optional

public ITerraformIterator ForEach { get; }

• Type: HashiCorp.Cdktf.ITerraformIterator

---

Lifecycle^Optional

public TerraformResourceLifecycle Lifecycle { get; }

• Type: HashiCorp.Cdktf.TerraformResourceLifecycle

---

Provider^Optional

public TerraformProvider Provider { get; }

• Type: HashiCorp.Cdktf.TerraformProvider

---

Provisioners^Optional

public object[] Provisioners { get; }

• Type: object[]

---

AllowConnectionsInput^Optional

public object AllowConnectionsInput { get; }

• Type: object

---

AlterObjectOwnershipInput^Optional

public object AlterObjectOwnershipInput { get; }

• Type: object

---

ConnectionLimitInput^Optional

public double ConnectionLimitInput { get; }

• Type: double

---

EncodingInput^Optional

public string EncodingInput { get; }

• Type: string

---

IdInput^Optional

public string IdInput { get; }

• Type: string

---

IsTemplateInput^Optional

public object IsTemplateInput { get; }

• Type: object

---

LcCollateInput^Optional

public string LcCollateInput { get; }

• Type: string

---

LcCtypeInput^Optional

public string LcCtypeInput { get; }

• Type: string

---

NameInput^Optional

public string NameInput { get; }

• Type: string

---

OwnerInput^Optional

public string OwnerInput { get; }

• Type: string

---

TablespaceNameInput^Optional

public string TablespaceNameInput { get; }

• Type: string

---

TemplateInput^Optional

public string TemplateInput { get; }

• Type: string

---

AllowConnections^Required

public object AllowConnections { get; }

• Type: object

---

AlterObjectOwnership^Required

public object AlterObjectOwnership { get; }

• Type: object

---

ConnectionLimit^Required

public double ConnectionLimit { get; }

• Type: double

---

Encoding^Required

public string Encoding { get; }

• Type: string

---

Id^Required

public string Id { get; }

• Type: string

---

IsTemplate^Required

public object IsTemplate { get; }

• Type: object

---

LcCollate^Required

public string LcCollate { get; }

• Type: string

---

LcCtype^Required

public string LcCtype { get; }

• Type: string

---

Name^Required

public string Name { get; }

• Type: string

---

Owner^Required

public string Owner { get; }

• Type: string

---

TablespaceName^Required

public string TablespaceName { get; }

• Type: string

---

Template^Required

public string Template { get; }

• Type: string

---

Constants

Name	Type	Description
TfResourceType	string	No description.

---

TfResourceType^Required

public string TfResourceType { get; }

• Type: string

---

Structs

DatabaseConfig

Initializer

using HashiCorp.Cdktf.Providers.Postgresql;

new DatabaseConfig {
    object Connection = null,
    object Count = null,
    ITerraformDependable[] DependsOn = null,
    ITerraformIterator ForEach = null,
    TerraformResourceLifecycle Lifecycle = null,
    TerraformProvider Provider = null,
    object[] Provisioners = null,
    string Name,
    object AllowConnections = null,
    object AlterObjectOwnership = null,
    double ConnectionLimit = null,
    string Encoding = null,
    string Id = null,
    object IsTemplate = null,
    string LcCollate = null,
    string LcCtype = null,
    string Owner = null,
    string TablespaceName = null,
    string Template = 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.
Name	string	The PostgreSQL database name to connect to.
AllowConnections	object	If false then no one can connect to this database.
AlterObjectOwnership	object	If true, the owner of already existing objects will change if the owner changes.
ConnectionLimit	double	How many concurrent connections can be made to this database.
Encoding	string	Character set encoding to use in the new database.
Id	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs/resources/database#id Database#id}.
IsTemplate	object	If true, then this database can be cloned by any user with CREATEDB privileges.
LcCollate	string	Collation order (LC_COLLATE) to use in the new database.
LcCtype	string	Character classification (LC_CTYPE) to use in the new database.
Owner	string	The ROLE which owns the database.
TablespaceName	string	The name of the tablespace that will be associated with the new database.
Template	string	The name of the template from which to create the new database.

---

Connection^Optional

public object Connection { get; set; }

• Type: object

---

Count^Optional

public object Count { get; set; }

• Type: object

---

DependsOn^Optional

public ITerraformDependable[] DependsOn { get; set; }

• Type: HashiCorp.Cdktf.ITerraformDependable[]

---

ForEach^Optional

public ITerraformIterator ForEach { get; set; }

• Type: HashiCorp.Cdktf.ITerraformIterator

---

Lifecycle^Optional

public TerraformResourceLifecycle Lifecycle { get; set; }

• Type: HashiCorp.Cdktf.TerraformResourceLifecycle

---

Provider^Optional

public TerraformProvider Provider { get; set; }

• Type: HashiCorp.Cdktf.TerraformProvider

---

Provisioners^Optional

public object[] Provisioners { get; set; }

• Type: object[]

---

Name^Required

public string Name { get; set; }

• Type: string

The PostgreSQL database name to connect to.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs/resources/database#name Database#name}

---

AllowConnections^Optional

public object AllowConnections { get; set; }

• Type: object

If false then no one can connect to this database.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs/resources/database#allow_connections Database#allow_connections}

---

AlterObjectOwnership^Optional

public object AlterObjectOwnership { get; set; }

• Type: object

If true, the owner of already existing objects will change if the owner changes.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs/resources/database#alter_object_ownership Database#alter_object_ownership}

---

ConnectionLimit^Optional

public double ConnectionLimit { get; set; }

• Type: double

How many concurrent connections can be made to this database.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs/resources/database#connection_limit Database#connection_limit}

---

Encoding^Optional

public string Encoding { get; set; }

• Type: string

Character set encoding to use in the new database.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs/resources/database#encoding Database#encoding}

---

Id^Optional

public string Id { get; set; }

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs/resources/database#id Database#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.

---

IsTemplate^Optional

public object IsTemplate { get; set; }

• Type: object

If true, then this database can be cloned by any user with CREATEDB privileges.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs/resources/database#is_template Database#is_template}

---

LcCollate^Optional

public string LcCollate { get; set; }

• Type: string

Collation order (LC_COLLATE) to use in the new database.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs/resources/database#lc_collate Database#lc_collate}

---

LcCtype^Optional

public string LcCtype { get; set; }

• Type: string

Character classification (LC_CTYPE) to use in the new database.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs/resources/database#lc_ctype Database#lc_ctype}

---

Owner^Optional

public string Owner { get; set; }

• Type: string

The ROLE which owns the database.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs/resources/database#owner Database#owner}

---

TablespaceName^Optional

public string TablespaceName { get; set; }

• Type: string

The name of the tablespace that will be associated with the new database.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs/resources/database#tablespace_name Database#tablespace_name}

---

Template^Optional

public string Template { get; set; }

• Type: string

The name of the template from which to create the new database.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs/resources/database#template Database#template}

---