Skip to content

Latest commit

 

History

History
1547 lines (983 loc) · 60.9 KB

database.python.md

File metadata and controls

1547 lines (983 loc) · 60.9 KB

database Submodule

Constructs

Database

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

Initializers 

from cdktf_cdktf_provider_postgresql import database

database.Database(
  scope: Construct,
  id: str,
  connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection] = None,
  count: typing.Union[typing.Union[int, float], TerraformCount] = None,
  depends_on: typing.List[ITerraformDependable] = None,
  for_each: ITerraformIterator = None,
  lifecycle: TerraformResourceLifecycle = None,
  provider: TerraformProvider = None,
  provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]] = None,
  name: str,
  allow_connections: typing.Union[bool, IResolvable] = None,
  alter_object_ownership: typing.Union[bool, IResolvable] = None,
  connection_limit: typing.Union[int, float] = None,
  encoding: str = None,
  id: str = None,
  is_template: typing.Union[bool, IResolvable] = None,
  lc_collate: str = None,
  lc_ctype: str = None,
  owner: str = None,
  tablespace_name: str = None,
  template: str = None
)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id str The scoped construct ID.
connection typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection] No description.
count typing.Union[typing.Union[int, float], cdktf.TerraformCount] No description.
depends_on typing.List[cdktf.ITerraformDependable] No description.
for_each cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]] No description.
name str The PostgreSQL database name to connect to.
allow_connections typing.Union[bool, cdktf.IResolvable] If false then no one can connect to this database.
alter_object_ownership typing.Union[bool, cdktf.IResolvable] If true, the owner of already existing objects will change if the owner changes.
connection_limit typing.Union[int, float] How many concurrent connections can be made to this database.
encoding str Character set encoding to use in the new database.
id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs/resources/database#id Database#id}.
is_template typing.Union[bool, cdktf.IResolvable] If true, then this database can be cloned by any user with CREATEDB privileges.
lc_collate str Collation order (LC_COLLATE) to use in the new database.
lc_ctype str Character classification (LC_CTYPE) to use in the new database.
owner str The ROLE which owns the database.
tablespace_name str The name of the tablespace that will be associated with the new database.
template str The name of the template from which to create the new database.
scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.

idRequired
  • Type: str

The scoped construct ID.

Must be unique amongst siblings in the same scope

connectionOptional
  • Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]
countOptional
  • Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]
depends_onOptional
  • Type: typing.List[cdktf.ITerraformDependable]
for_eachOptional
  • Type: cdktf.ITerraformIterator
lifecycleOptional
  • Type: cdktf.TerraformResourceLifecycle
providerOptional
  • Type: cdktf.TerraformProvider
provisionersOptional
  • Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]
nameRequired
  • Type: str

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}

allow_connectionsOptional
  • Type: typing.Union[bool, cdktf.IResolvable]

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}

alter_object_ownershipOptional
  • Type: typing.Union[bool, cdktf.IResolvable]

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}

connection_limitOptional
  • Type: typing.Union[int, float]

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}

encodingOptional
  • Type: str

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}

idOptional
  • Type: str

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.

is_templateOptional
  • Type: typing.Union[bool, cdktf.IResolvable]

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}

lc_collateOptional
  • Type: str

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}

lc_ctypeOptional
  • Type: str

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}

ownerOptional
  • Type: str

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}

tablespace_nameOptional
  • Type: str

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}

templateOptional
  • Type: str

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}

Methods

Name Description
to_string Returns a string representation of this construct.
add_override No description.
override_logical_id Overrides the auto-generated logical ID with a specific ID.
reset_override_logical_id Resets a previously passed logical Id to use the auto-generated logical id again.
to_hcl_terraform No description.
to_metadata No description.
to_terraform Adds this resource to the terraform JSON output.
add_move_target Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
get_any_map_attribute No description.
get_boolean_attribute No description.
get_boolean_map_attribute No description.
get_list_attribute No description.
get_number_attribute No description.
get_number_list_attribute No description.
get_number_map_attribute No description.
get_string_attribute No description.
get_string_map_attribute No description.
has_resource_move No description.
import_from No description.
interpolation_for_attribute No description.
move_from_id Move the resource corresponding to "id" to this resource.
move_to Moves this resource to the target resource given by moveTarget.
move_to_id Moves this resource to the resource corresponding to "id".
reset_allow_connections No description.
reset_alter_object_ownership No description.
reset_connection_limit No description.
reset_encoding No description.
reset_id No description.
reset_is_template No description.
reset_lc_collate No description.
reset_lc_ctype No description.
reset_owner No description.
reset_tablespace_name No description.
reset_template No description.
to_string 
def to_string() -> str

Returns a string representation of this construct.

add_override 
def add_override(
  path: str,
  value: typing.Any
) -> None
pathRequired
  • Type: str
valueRequired
  • Type: typing.Any
override_logical_id 
def override_logical_id(
  new_logical_id: str
) -> None

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

new_logical_idRequired
  • Type: str

The new logical ID to use for this stack element.

reset_override_logical_id 
def reset_override_logical_id() -> None

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

to_hcl_terraform 
def to_hcl_terraform() -> typing.Any
to_metadata 
def to_metadata() -> typing.Any
to_terraform 
def to_terraform() -> typing.Any

Adds this resource to the terraform JSON output.

add_move_target 
def add_move_target(
  move_target: str
) -> None

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

move_targetRequired
  • Type: str

The string move target that will correspond to this resource.

get_any_map_attribute 
def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]
terraform_attributeRequired
  • Type: str
get_boolean_attribute 
def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str
get_boolean_map_attribute 
def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]
terraform_attributeRequired
  • Type: str
get_list_attribute 
def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]
terraform_attributeRequired
  • Type: str
get_number_attribute 
def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]
terraform_attributeRequired
  • Type: str
get_number_list_attribute 
def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_number_map_attribute 
def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_string_attribute 
def get_string_attribute(
  terraform_attribute: str
) -> str
terraform_attributeRequired
  • Type: str
get_string_map_attribute 
def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]
terraform_attributeRequired
  • Type: str
has_resource_move 
def has_resource_move() -> typing.Union[TerraformResourceMoveByTarget, TerraformResourceMoveById]
import_from 
def import_from(
  id: str,
  provider: TerraformProvider = None
) -> None
idRequired
  • Type: str
providerOptional
  • Type: cdktf.TerraformProvider
interpolation_for_attribute 
def interpolation_for_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str
move_from_id 
def move_from_id(
  id: str
) -> None

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

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

move_to 
def move_to(
  move_target: str,
  index: typing.Union[str, typing.Union[int, float]] = None
) -> None

Moves this resource to the target resource given by moveTarget.

move_targetRequired
  • Type: str

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

indexOptional
  • Type: typing.Union[str, typing.Union[int, float]]

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

move_to_id 
def move_to_id(
  id: str
) -> None

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

idRequired
  • Type: str

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

reset_allow_connections 
def reset_allow_connections() -> None
reset_alter_object_ownership 
def reset_alter_object_ownership() -> None
reset_connection_limit 
def reset_connection_limit() -> None
reset_encoding 
def reset_encoding() -> None
reset_id 
def reset_id() -> None
reset_is_template 
def reset_is_template() -> None
reset_lc_collate 
def reset_lc_collate() -> None
reset_lc_ctype 
def reset_lc_ctype() -> None
reset_owner 
def reset_owner() -> None
reset_tablespace_name 
def reset_tablespace_name() -> None
reset_template 
def reset_template() -> None

Static Functions

Name Description
is_construct Checks if x is a construct.
is_terraform_element No description.
is_terraform_resource No description.
generate_config_for_import Generates CDKTF code for importing a Database resource upon running "cdktf plan ".
is_construct 
from cdktf_cdktf_provider_postgresql import database

database.Database.is_construct(
  x: typing.Any
)

Checks if x is a construct.

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

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

xRequired
  • Type: typing.Any

Any object.

is_terraform_element 
from cdktf_cdktf_provider_postgresql import database

database.Database.is_terraform_element(
  x: typing.Any
)
xRequired
  • Type: typing.Any
is_terraform_resource 
from cdktf_cdktf_provider_postgresql import database

database.Database.is_terraform_resource(
  x: typing.Any
)
xRequired
  • Type: typing.Any
generate_config_for_import 
from cdktf_cdktf_provider_postgresql import database

database.Database.generate_config_for_import(
  scope: Construct,
  import_to_id: str,
  import_from_id: str,
  provider: TerraformProvider = None
)

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

scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.

import_to_idRequired
  • Type: str

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

import_from_idRequired
  • Type: str

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

providerOptional
  • Type: cdktf.TerraformProvider

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

Properties

Name Type Description
node constructs.Node The tree node.
cdktf_stack cdktf.TerraformStack No description.
fqn str No description.
friendly_unique_id str No description.
terraform_meta_arguments typing.Mapping[typing.Any] No description.
terraform_resource_type str No description.
terraform_generator_metadata cdktf.TerraformProviderGeneratorMetadata No description.
connection typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection] No description.
count typing.Union[typing.Union[int, float], cdktf.TerraformCount] No description.
depends_on typing.List[str] No description.
for_each cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]] No description.
allow_connections_input typing.Union[bool, cdktf.IResolvable] No description.
alter_object_ownership_input typing.Union[bool, cdktf.IResolvable] No description.
connection_limit_input typing.Union[int, float] No description.
encoding_input str No description.
id_input str No description.
is_template_input typing.Union[bool, cdktf.IResolvable] No description.
lc_collate_input str No description.
lc_ctype_input str No description.
name_input str No description.
owner_input str No description.
tablespace_name_input str No description.
template_input str No description.
allow_connections typing.Union[bool, cdktf.IResolvable] No description.
alter_object_ownership typing.Union[bool, cdktf.IResolvable] No description.
connection_limit typing.Union[int, float] No description.
encoding str No description.
id str No description.
is_template typing.Union[bool, cdktf.IResolvable] No description.
lc_collate str No description.
lc_ctype str No description.
name str No description.
owner str No description.
tablespace_name str No description.
template str No description.
nodeRequired 
node: Node
  • Type: constructs.Node

The tree node.

cdktf_stackRequired 
cdktf_stack: TerraformStack
  • Type: cdktf.TerraformStack
fqnRequired 
fqn: str
  • Type: str
friendly_unique_idRequired 
friendly_unique_id: str
  • Type: str
terraform_meta_argumentsRequired 
terraform_meta_arguments: typing.Mapping[typing.Any]
  • Type: typing.Mapping[typing.Any]
terraform_resource_typeRequired 
terraform_resource_type: str
  • Type: str
terraform_generator_metadataOptional 
terraform_generator_metadata: TerraformProviderGeneratorMetadata
  • Type: cdktf.TerraformProviderGeneratorMetadata
connectionOptional 
connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection]
  • Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]
countOptional 
count: typing.Union[typing.Union[int, float], TerraformCount]
  • Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]
depends_onOptional 
depends_on: typing.List[str]
  • Type: typing.List[str]
for_eachOptional 
for_each: ITerraformIterator
  • Type: cdktf.ITerraformIterator
lifecycleOptional 
lifecycle: TerraformResourceLifecycle
  • Type: cdktf.TerraformResourceLifecycle
providerOptional 
provider: TerraformProvider
  • Type: cdktf.TerraformProvider
provisionersOptional 
provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]]
  • Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]
allow_connections_inputOptional 
allow_connections_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
alter_object_ownership_inputOptional 
alter_object_ownership_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
connection_limit_inputOptional 
connection_limit_input: typing.Union[int, float]
  • Type: typing.Union[int, float]
encoding_inputOptional 
encoding_input: str
  • Type: str
id_inputOptional 
id_input: str
  • Type: str
is_template_inputOptional 
is_template_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
lc_collate_inputOptional 
lc_collate_input: str
  • Type: str
lc_ctype_inputOptional 
lc_ctype_input: str
  • Type: str
name_inputOptional 
name_input: str
  • Type: str
owner_inputOptional 
owner_input: str
  • Type: str
tablespace_name_inputOptional 
tablespace_name_input: str
  • Type: str
template_inputOptional 
template_input: str
  • Type: str
allow_connectionsRequired 
allow_connections: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
alter_object_ownershipRequired 
alter_object_ownership: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
connection_limitRequired 
connection_limit: typing.Union[int, float]
  • Type: typing.Union[int, float]
encodingRequired 
encoding: str
  • Type: str
idRequired 
id: str
  • Type: str
is_templateRequired 
is_template: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
lc_collateRequired 
lc_collate: str
  • Type: str
lc_ctypeRequired 
lc_ctype: str
  • Type: str
nameRequired 
name: str
  • Type: str
ownerRequired 
owner: str
  • Type: str
tablespace_nameRequired 
tablespace_name: str
  • Type: str
templateRequired 
template: str
  • Type: str

Constants

Name Type Description
tfResourceType str No description.
tfResourceTypeRequired 
tfResourceType: str
  • Type: str

Structs

DatabaseConfig

Initializer 

from cdktf_cdktf_provider_postgresql import database

database.DatabaseConfig(
  connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection] = None,
  count: typing.Union[typing.Union[int, float], TerraformCount] = None,
  depends_on: typing.List[ITerraformDependable] = None,
  for_each: ITerraformIterator = None,
  lifecycle: TerraformResourceLifecycle = None,
  provider: TerraformProvider = None,
  provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]] = None,
  name: str,
  allow_connections: typing.Union[bool, IResolvable] = None,
  alter_object_ownership: typing.Union[bool, IResolvable] = None,
  connection_limit: typing.Union[int, float] = None,
  encoding: str = None,
  id: str = None,
  is_template: typing.Union[bool, IResolvable] = None,
  lc_collate: str = None,
  lc_ctype: str = None,
  owner: str = None,
  tablespace_name: str = None,
  template: str = None
)

Properties

Name Type Description
connection typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection] No description.
count typing.Union[typing.Union[int, float], cdktf.TerraformCount] No description.
depends_on typing.List[cdktf.ITerraformDependable] No description.
for_each cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]] No description.
name str The PostgreSQL database name to connect to.
allow_connections typing.Union[bool, cdktf.IResolvable] If false then no one can connect to this database.
alter_object_ownership typing.Union[bool, cdktf.IResolvable] If true, the owner of already existing objects will change if the owner changes.
connection_limit typing.Union[int, float] How many concurrent connections can be made to this database.
encoding str Character set encoding to use in the new database.
id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs/resources/database#id Database#id}.
is_template typing.Union[bool, cdktf.IResolvable] If true, then this database can be cloned by any user with CREATEDB privileges.
lc_collate str Collation order (LC_COLLATE) to use in the new database.
lc_ctype str Character classification (LC_CTYPE) to use in the new database.
owner str The ROLE which owns the database.
tablespace_name str The name of the tablespace that will be associated with the new database.
template str The name of the template from which to create the new database.
connectionOptional 
connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection]
  • Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]
countOptional 
count: typing.Union[typing.Union[int, float], TerraformCount]
  • Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]
depends_onOptional 
depends_on: typing.List[ITerraformDependable]
  • Type: typing.List[cdktf.ITerraformDependable]
for_eachOptional 
for_each: ITerraformIterator
  • Type: cdktf.ITerraformIterator
lifecycleOptional 
lifecycle: TerraformResourceLifecycle
  • Type: cdktf.TerraformResourceLifecycle
providerOptional 
provider: TerraformProvider
  • Type: cdktf.TerraformProvider
provisionersOptional 
provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]]
  • Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]
nameRequired 
name: str
  • Type: str

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}

allow_connectionsOptional 
allow_connections: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

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}

alter_object_ownershipOptional 
alter_object_ownership: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

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}

connection_limitOptional 
connection_limit: typing.Union[int, float]
  • Type: typing.Union[int, float]

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}

encodingOptional 
encoding: str
  • Type: str

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}

idOptional 
id: str
  • Type: str

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.

is_templateOptional 
is_template: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

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}

lc_collateOptional 
lc_collate: str
  • Type: str

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}

lc_ctypeOptional 
lc_ctype: str
  • Type: str

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}

ownerOptional 
owner: str
  • Type: str

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}

tablespace_nameOptional 
tablespace_name: str
  • Type: str

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}

templateOptional 
template: str
  • Type: str

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}