Skip to content

Latest commit

 

History

History
1765 lines (1113 loc) · 75.4 KB

provider.python.md

File metadata and controls

1765 lines (1113 loc) · 75.4 KB

provider Submodule

Constructs

PostgresqlProvider

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

Initializers 

from cdktf_cdktf_provider_postgresql import provider

provider.PostgresqlProvider(
  scope: Construct,
  id: str,
  alias: str = None,
  aws_rds_iam_auth: typing.Union[bool, IResolvable] = None,
  aws_rds_iam_profile: str = None,
  aws_rds_iam_provider_role_arn: str = None,
  aws_rds_iam_region: str = None,
  azure_identity_auth: typing.Union[bool, IResolvable] = None,
  azure_tenant_id: str = None,
  clientcert: PostgresqlProviderClientcert = None,
  connect_timeout: typing.Union[int, float] = None,
  database: str = None,
  database_username: str = None,
  expected_version: str = None,
  gcp_iam_impersonate_service_account: str = None,
  host: str = None,
  max_connections: typing.Union[int, float] = None,
  password: str = None,
  port: typing.Union[int, float] = None,
  scheme: str = None,
  sslmode: str = None,
  ssl_mode: str = None,
  sslrootcert: str = None,
  superuser: typing.Union[bool, IResolvable] = None,
  username: str = None
)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id str The scoped construct ID.
alias str Alias name.
aws_rds_iam_auth typing.Union[bool, cdktf.IResolvable] Use rds_iam instead of password authentication (see: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html).
aws_rds_iam_profile str AWS profile to use for IAM auth.
aws_rds_iam_provider_role_arn str AWS IAM role to assume for IAM auth.
aws_rds_iam_region str AWS region to use for IAM auth.
azure_identity_auth typing.Union[bool, cdktf.IResolvable] Use MS Azure identity OAuth token (see: https://learn.microsoft.com/en-us/azure/postgresql/flexible-server/how-to-configure-sign-in-azure-ad-authentication).
azure_tenant_id str MS Azure tenant ID (see: https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/data-sources/client_config.html).
clientcert PostgresqlProviderClientcert clientcert block.
connect_timeout typing.Union[int, float] Maximum wait for connection, in seconds. Zero or not specified means wait indefinitely.
database str The name of the database to connect to in order to conenct to (defaults to postgres).
database_username str Database username associated to the connected user (for user name maps).
expected_version str Specify the expected version of PostgreSQL.
gcp_iam_impersonate_service_account str Service account to impersonate when using GCP IAM authentication.
host str Name of PostgreSQL server address to connect to.
max_connections typing.Union[int, float] Maximum number of connections to establish to the database. Zero means unlimited.
password str Password to be used if the PostgreSQL server demands password authentication.
port typing.Union[int, float] The PostgreSQL port number to connect to at the server host, or socket file name extension for Unix-domain connections.
scheme str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs#scheme PostgresqlProvider#scheme}.
sslmode str This option determines whether or with what priority a secure SSL TCP/IP connection will be negotiated with the PostgreSQL server.
ssl_mode str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs#ssl_mode PostgresqlProvider#ssl_mode}.
sslrootcert str The SSL server root certificate file path. The file must contain PEM encoded data.
superuser typing.Union[bool, cdktf.IResolvable] Specify if the user to connect as is a Postgres superuser or not.If not, some feature might be disabled (e.g.: Refreshing state password from Postgres).
username str PostgreSQL user name to connect as.
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

aliasOptional
  • Type: str

Alias name.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs#alias PostgresqlProvider#alias}

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

Use rds_iam instead of password authentication (see: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs#aws_rds_iam_auth PostgresqlProvider#aws_rds_iam_auth}

aws_rds_iam_profileOptional
  • Type: str

AWS profile to use for IAM auth.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs#aws_rds_iam_profile PostgresqlProvider#aws_rds_iam_profile}

aws_rds_iam_provider_role_arnOptional
  • Type: str

AWS IAM role to assume for IAM auth.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs#aws_rds_iam_provider_role_arn PostgresqlProvider#aws_rds_iam_provider_role_arn}

aws_rds_iam_regionOptional
  • Type: str

AWS region to use for IAM auth.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs#aws_rds_iam_region PostgresqlProvider#aws_rds_iam_region}

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

Use MS Azure identity OAuth token (see: https://learn.microsoft.com/en-us/azure/postgresql/flexible-server/how-to-configure-sign-in-azure-ad-authentication).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs#azure_identity_auth PostgresqlProvider#azure_identity_auth}

azure_tenant_idOptional
  • Type: str

MS Azure tenant ID (see: https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/data-sources/client_config.html).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs#azure_tenant_id PostgresqlProvider#azure_tenant_id}

clientcertOptional

clientcert block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs#clientcert PostgresqlProvider#clientcert}

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

Maximum wait for connection, in seconds. Zero or not specified means wait indefinitely.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs#connect_timeout PostgresqlProvider#connect_timeout}

databaseOptional
  • Type: str

The name of the database to connect to in order to conenct to (defaults to postgres).

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

database_usernameOptional
  • Type: str

Database username associated to the connected user (for user name maps).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs#database_username PostgresqlProvider#database_username}

expected_versionOptional
  • Type: str

Specify the expected version of PostgreSQL.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs#expected_version PostgresqlProvider#expected_version}

gcp_iam_impersonate_service_accountOptional
  • Type: str

Service account to impersonate when using GCP IAM authentication.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs#gcp_iam_impersonate_service_account PostgresqlProvider#gcp_iam_impersonate_service_account}

hostOptional
  • Type: str

Name of PostgreSQL server address to connect to.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs#host PostgresqlProvider#host}

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

Maximum number of connections to establish to the database. Zero means unlimited.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs#max_connections PostgresqlProvider#max_connections}

passwordOptional
  • Type: str

Password to be used if the PostgreSQL server demands password authentication.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs#password PostgresqlProvider#password}

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

The PostgreSQL port number to connect to at the server host, or socket file name extension for Unix-domain connections.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs#port PostgresqlProvider#port}

schemeOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs#scheme PostgresqlProvider#scheme}.

sslmodeOptional
  • Type: str

This option determines whether or with what priority a secure SSL TCP/IP connection will be negotiated with the PostgreSQL server.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs#sslmode PostgresqlProvider#sslmode}

ssl_modeOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs#ssl_mode PostgresqlProvider#ssl_mode}.

sslrootcertOptional
  • Type: str

The SSL server root certificate file path. The file must contain PEM encoded data.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs#sslrootcert PostgresqlProvider#sslrootcert}

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

Specify if the user to connect as is a Postgres superuser or not.If not, some feature might be disabled (e.g.: Refreshing state password from Postgres).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs#superuser PostgresqlProvider#superuser}

usernameOptional
  • Type: str

PostgreSQL user name to connect as.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs#username PostgresqlProvider#username}

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.
reset_alias No description.
reset_aws_rds_iam_auth No description.
reset_aws_rds_iam_profile No description.
reset_aws_rds_iam_provider_role_arn No description.
reset_aws_rds_iam_region No description.
reset_azure_identity_auth No description.
reset_azure_tenant_id No description.
reset_clientcert No description.
reset_connect_timeout No description.
reset_database No description.
reset_database_username No description.
reset_expected_version No description.
reset_gcp_iam_impersonate_service_account No description.
reset_host No description.
reset_max_connections No description.
reset_password No description.
reset_port No description.
reset_scheme No description.
reset_sslmode No description.
reset_ssl_mode No description.
reset_sslrootcert No description.
reset_superuser No description.
reset_username 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.

reset_alias 
def reset_alias() -> None
reset_aws_rds_iam_auth 
def reset_aws_rds_iam_auth() -> None
reset_aws_rds_iam_profile 
def reset_aws_rds_iam_profile() -> None
reset_aws_rds_iam_provider_role_arn 
def reset_aws_rds_iam_provider_role_arn() -> None
reset_aws_rds_iam_region 
def reset_aws_rds_iam_region() -> None
reset_azure_identity_auth 
def reset_azure_identity_auth() -> None
reset_azure_tenant_id 
def reset_azure_tenant_id() -> None
reset_clientcert 
def reset_clientcert() -> None
reset_connect_timeout 
def reset_connect_timeout() -> None
reset_database 
def reset_database() -> None
reset_database_username 
def reset_database_username() -> None
reset_expected_version 
def reset_expected_version() -> None
reset_gcp_iam_impersonate_service_account 
def reset_gcp_iam_impersonate_service_account() -> None
reset_host 
def reset_host() -> None
reset_max_connections 
def reset_max_connections() -> None
reset_password 
def reset_password() -> None
reset_port 
def reset_port() -> None
reset_scheme 
def reset_scheme() -> None
reset_sslmode 
def reset_sslmode() -> None
reset_ssl_mode 
def reset_ssl_mode() -> None
reset_sslrootcert 
def reset_sslrootcert() -> None
reset_superuser 
def reset_superuser() -> None
reset_username 
def reset_username() -> None

Static Functions

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

provider.PostgresqlProvider.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 provider

provider.PostgresqlProvider.is_terraform_element(
  x: typing.Any
)
xRequired
  • Type: typing.Any
is_terraform_provider 
from cdktf_cdktf_provider_postgresql import provider

provider.PostgresqlProvider.is_terraform_provider(
  x: typing.Any
)
xRequired
  • Type: typing.Any
generate_config_for_import 
from cdktf_cdktf_provider_postgresql import provider

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

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

import_from_idRequired
  • Type: str

The id of the existing PostgresqlProvider that should be imported.

Refer to the {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs#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 PostgresqlProvider 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.
meta_attributes typing.Mapping[typing.Any] No description.
terraform_resource_type str No description.
terraform_generator_metadata cdktf.TerraformProviderGeneratorMetadata No description.
terraform_provider_source str No description.
alias str No description.
alias_input str No description.
aws_rds_iam_auth_input typing.Union[bool, cdktf.IResolvable] No description.
aws_rds_iam_profile_input str No description.
aws_rds_iam_provider_role_arn_input str No description.
aws_rds_iam_region_input str No description.
azure_identity_auth_input typing.Union[bool, cdktf.IResolvable] No description.
azure_tenant_id_input str No description.
clientcert_input PostgresqlProviderClientcert No description.
connect_timeout_input typing.Union[int, float] No description.
database_input str No description.
database_username_input str No description.
expected_version_input str No description.
gcp_iam_impersonate_service_account_input str No description.
host_input str No description.
max_connections_input typing.Union[int, float] No description.
password_input str No description.
port_input typing.Union[int, float] No description.
scheme_input str No description.
sslmode_input str No description.
ssl_mode_input str No description.
sslrootcert_input str No description.
superuser_input typing.Union[bool, cdktf.IResolvable] No description.
username_input str No description.
aws_rds_iam_auth typing.Union[bool, cdktf.IResolvable] No description.
aws_rds_iam_profile str No description.
aws_rds_iam_provider_role_arn str No description.
aws_rds_iam_region str No description.
azure_identity_auth typing.Union[bool, cdktf.IResolvable] No description.
azure_tenant_id str No description.
clientcert PostgresqlProviderClientcert No description.
connect_timeout typing.Union[int, float] No description.
database str No description.
database_username str No description.
expected_version str No description.
gcp_iam_impersonate_service_account str No description.
host str No description.
max_connections typing.Union[int, float] No description.
password str No description.
port typing.Union[int, float] No description.
scheme str No description.
sslmode str No description.
ssl_mode str No description.
sslrootcert str No description.
superuser typing.Union[bool, cdktf.IResolvable] No description.
username 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
meta_attributesRequired 
meta_attributes: 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
terraform_provider_sourceOptional 
terraform_provider_source: str
  • Type: str
aliasOptional 
alias: str
  • Type: str
alias_inputOptional 
alias_input: str
  • Type: str
aws_rds_iam_auth_inputOptional 
aws_rds_iam_auth_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
aws_rds_iam_profile_inputOptional 
aws_rds_iam_profile_input: str
  • Type: str
aws_rds_iam_provider_role_arn_inputOptional 
aws_rds_iam_provider_role_arn_input: str
  • Type: str
aws_rds_iam_region_inputOptional 
aws_rds_iam_region_input: str
  • Type: str
azure_identity_auth_inputOptional 
azure_identity_auth_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
azure_tenant_id_inputOptional 
azure_tenant_id_input: str
  • Type: str
clientcert_inputOptional 
clientcert_input: PostgresqlProviderClientcert
connect_timeout_inputOptional 
connect_timeout_input: typing.Union[int, float]
  • Type: typing.Union[int, float]
database_inputOptional 
database_input: str
  • Type: str
database_username_inputOptional 
database_username_input: str
  • Type: str
expected_version_inputOptional 
expected_version_input: str
  • Type: str
gcp_iam_impersonate_service_account_inputOptional 
gcp_iam_impersonate_service_account_input: str
  • Type: str
host_inputOptional 
host_input: str
  • Type: str
max_connections_inputOptional 
max_connections_input: typing.Union[int, float]
  • Type: typing.Union[int, float]
password_inputOptional 
password_input: str
  • Type: str
port_inputOptional 
port_input: typing.Union[int, float]
  • Type: typing.Union[int, float]
scheme_inputOptional 
scheme_input: str
  • Type: str
sslmode_inputOptional 
sslmode_input: str
  • Type: str
ssl_mode_inputOptional 
ssl_mode_input: str
  • Type: str
sslrootcert_inputOptional 
sslrootcert_input: str
  • Type: str
superuser_inputOptional 
superuser_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
username_inputOptional 
username_input: str
  • Type: str
aws_rds_iam_authOptional 
aws_rds_iam_auth: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
aws_rds_iam_profileOptional 
aws_rds_iam_profile: str
  • Type: str
aws_rds_iam_provider_role_arnOptional 
aws_rds_iam_provider_role_arn: str
  • Type: str
aws_rds_iam_regionOptional 
aws_rds_iam_region: str
  • Type: str
azure_identity_authOptional 
azure_identity_auth: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
azure_tenant_idOptional 
azure_tenant_id: str
  • Type: str
clientcertOptional 
clientcert: PostgresqlProviderClientcert
connect_timeoutOptional 
connect_timeout: typing.Union[int, float]
  • Type: typing.Union[int, float]
databaseOptional 
database: str
  • Type: str
database_usernameOptional 
database_username: str
  • Type: str
expected_versionOptional 
expected_version: str
  • Type: str
gcp_iam_impersonate_service_accountOptional 
gcp_iam_impersonate_service_account: str
  • Type: str
hostOptional 
host: str
  • Type: str
max_connectionsOptional 
max_connections: typing.Union[int, float]
  • Type: typing.Union[int, float]
passwordOptional 
password: str
  • Type: str
portOptional 
port: typing.Union[int, float]
  • Type: typing.Union[int, float]
schemeOptional 
scheme: str
  • Type: str
sslmodeOptional 
sslmode: str
  • Type: str
ssl_modeOptional 
ssl_mode: str
  • Type: str
sslrootcertOptional 
sslrootcert: str
  • Type: str
superuserOptional 
superuser: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
usernameOptional 
username: str
  • Type: str

Constants

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

Structs

PostgresqlProviderClientcert

Initializer 

from cdktf_cdktf_provider_postgresql import provider

provider.PostgresqlProviderClientcert(
  cert: str,
  key: str,
  sslinline: typing.Union[bool, IResolvable] = None
)

Properties

Name Type Description
cert str The SSL client certificate file path. The file must contain PEM encoded data.
key str The SSL client certificate private key file path. The file must contain PEM encoded data.
sslinline typing.Union[bool, cdktf.IResolvable] Must be set to true if you are inlining the cert/key instead of using a file path.
certRequired 
cert: str
  • Type: str

The SSL client certificate file path. The file must contain PEM encoded data.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs#cert PostgresqlProvider#cert}

keyRequired 
key: str
  • Type: str

The SSL client certificate private key file path. The file must contain PEM encoded data.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs#key PostgresqlProvider#key}

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

Must be set to true if you are inlining the cert/key instead of using a file path.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs#sslinline PostgresqlProvider#sslinline}

PostgresqlProviderConfig

Initializer 

from cdktf_cdktf_provider_postgresql import provider

provider.PostgresqlProviderConfig(
  alias: str = None,
  aws_rds_iam_auth: typing.Union[bool, IResolvable] = None,
  aws_rds_iam_profile: str = None,
  aws_rds_iam_provider_role_arn: str = None,
  aws_rds_iam_region: str = None,
  azure_identity_auth: typing.Union[bool, IResolvable] = None,
  azure_tenant_id: str = None,
  clientcert: PostgresqlProviderClientcert = None,
  connect_timeout: typing.Union[int, float] = None,
  database: str = None,
  database_username: str = None,
  expected_version: str = None,
  gcp_iam_impersonate_service_account: str = None,
  host: str = None,
  max_connections: typing.Union[int, float] = None,
  password: str = None,
  port: typing.Union[int, float] = None,
  scheme: str = None,
  sslmode: str = None,
  ssl_mode: str = None,
  sslrootcert: str = None,
  superuser: typing.Union[bool, IResolvable] = None,
  username: str = None
)

Properties

Name Type Description
alias str Alias name.
aws_rds_iam_auth typing.Union[bool, cdktf.IResolvable] Use rds_iam instead of password authentication (see: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html).
aws_rds_iam_profile str AWS profile to use for IAM auth.
aws_rds_iam_provider_role_arn str AWS IAM role to assume for IAM auth.
aws_rds_iam_region str AWS region to use for IAM auth.
azure_identity_auth typing.Union[bool, cdktf.IResolvable] Use MS Azure identity OAuth token (see: https://learn.microsoft.com/en-us/azure/postgresql/flexible-server/how-to-configure-sign-in-azure-ad-authentication).
azure_tenant_id str MS Azure tenant ID (see: https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/data-sources/client_config.html).
clientcert PostgresqlProviderClientcert clientcert block.
connect_timeout typing.Union[int, float] Maximum wait for connection, in seconds. Zero or not specified means wait indefinitely.
database str The name of the database to connect to in order to conenct to (defaults to postgres).
database_username str Database username associated to the connected user (for user name maps).
expected_version str Specify the expected version of PostgreSQL.
gcp_iam_impersonate_service_account str Service account to impersonate when using GCP IAM authentication.
host str Name of PostgreSQL server address to connect to.
max_connections typing.Union[int, float] Maximum number of connections to establish to the database. Zero means unlimited.
password str Password to be used if the PostgreSQL server demands password authentication.
port typing.Union[int, float] The PostgreSQL port number to connect to at the server host, or socket file name extension for Unix-domain connections.
scheme str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs#scheme PostgresqlProvider#scheme}.
sslmode str This option determines whether or with what priority a secure SSL TCP/IP connection will be negotiated with the PostgreSQL server.
ssl_mode str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs#ssl_mode PostgresqlProvider#ssl_mode}.
sslrootcert str The SSL server root certificate file path. The file must contain PEM encoded data.
superuser typing.Union[bool, cdktf.IResolvable] Specify if the user to connect as is a Postgres superuser or not.If not, some feature might be disabled (e.g.: Refreshing state password from Postgres).
username str PostgreSQL user name to connect as.
aliasOptional 
alias: str
  • Type: str

Alias name.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs#alias PostgresqlProvider#alias}

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

Use rds_iam instead of password authentication (see: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs#aws_rds_iam_auth PostgresqlProvider#aws_rds_iam_auth}

aws_rds_iam_profileOptional 
aws_rds_iam_profile: str
  • Type: str

AWS profile to use for IAM auth.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs#aws_rds_iam_profile PostgresqlProvider#aws_rds_iam_profile}

aws_rds_iam_provider_role_arnOptional 
aws_rds_iam_provider_role_arn: str
  • Type: str

AWS IAM role to assume for IAM auth.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs#aws_rds_iam_provider_role_arn PostgresqlProvider#aws_rds_iam_provider_role_arn}

aws_rds_iam_regionOptional 
aws_rds_iam_region: str
  • Type: str

AWS region to use for IAM auth.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs#aws_rds_iam_region PostgresqlProvider#aws_rds_iam_region}

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

Use MS Azure identity OAuth token (see: https://learn.microsoft.com/en-us/azure/postgresql/flexible-server/how-to-configure-sign-in-azure-ad-authentication).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs#azure_identity_auth PostgresqlProvider#azure_identity_auth}

azure_tenant_idOptional 
azure_tenant_id: str
  • Type: str

MS Azure tenant ID (see: https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/data-sources/client_config.html).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs#azure_tenant_id PostgresqlProvider#azure_tenant_id}

clientcertOptional 
clientcert: PostgresqlProviderClientcert

clientcert block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs#clientcert PostgresqlProvider#clientcert}

connect_timeoutOptional 
connect_timeout: typing.Union[int, float]
  • Type: typing.Union[int, float]

Maximum wait for connection, in seconds. Zero or not specified means wait indefinitely.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs#connect_timeout PostgresqlProvider#connect_timeout}

databaseOptional 
database: str
  • Type: str

The name of the database to connect to in order to conenct to (defaults to postgres).

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

database_usernameOptional 
database_username: str
  • Type: str

Database username associated to the connected user (for user name maps).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs#database_username PostgresqlProvider#database_username}

expected_versionOptional 
expected_version: str
  • Type: str

Specify the expected version of PostgreSQL.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs#expected_version PostgresqlProvider#expected_version}

gcp_iam_impersonate_service_accountOptional 
gcp_iam_impersonate_service_account: str
  • Type: str

Service account to impersonate when using GCP IAM authentication.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs#gcp_iam_impersonate_service_account PostgresqlProvider#gcp_iam_impersonate_service_account}

hostOptional 
host: str
  • Type: str

Name of PostgreSQL server address to connect to.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs#host PostgresqlProvider#host}

max_connectionsOptional 
max_connections: typing.Union[int, float]
  • Type: typing.Union[int, float]

Maximum number of connections to establish to the database. Zero means unlimited.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs#max_connections PostgresqlProvider#max_connections}

passwordOptional 
password: str
  • Type: str

Password to be used if the PostgreSQL server demands password authentication.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs#password PostgresqlProvider#password}

portOptional 
port: typing.Union[int, float]
  • Type: typing.Union[int, float]

The PostgreSQL port number to connect to at the server host, or socket file name extension for Unix-domain connections.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs#port PostgresqlProvider#port}

schemeOptional 
scheme: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs#scheme PostgresqlProvider#scheme}.

sslmodeOptional 
sslmode: str
  • Type: str

This option determines whether or with what priority a secure SSL TCP/IP connection will be negotiated with the PostgreSQL server.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs#sslmode PostgresqlProvider#sslmode}

ssl_modeOptional 
ssl_mode: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs#ssl_mode PostgresqlProvider#ssl_mode}.

sslrootcertOptional 
sslrootcert: str
  • Type: str

The SSL server root certificate file path. The file must contain PEM encoded data.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs#sslrootcert PostgresqlProvider#sslrootcert}

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

Specify if the user to connect as is a Postgres superuser or not.If not, some feature might be disabled (e.g.: Refreshing state password from Postgres).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs#superuser PostgresqlProvider#superuser}

usernameOptional 
username: str
  • Type: str

PostgreSQL user name to connect as.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs#username PostgresqlProvider#username}