Represents a {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs postgresql}.
using HashiCorp.Cdktf.Providers.Postgresql;
new PostgresqlProvider(Construct Scope, string Id, PostgresqlProviderConfig Config = null);
Name | Type | Description |
---|---|---|
Scope |
Constructs.Construct |
The scope in which to define this construct. |
Id |
string |
The scoped construct ID. |
Config |
PostgresqlProviderConfig |
No description. |
- Type: Constructs.Construct
The scope in which to define this construct.
- Type: string
The scoped construct ID.
Must be unique amongst siblings in the same scope
- Type: PostgresqlProviderConfig
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. |
ResetAlias |
No description. |
ResetAwsRdsIamAuth |
No description. |
ResetAwsRdsIamProfile |
No description. |
ResetAwsRdsIamProviderRoleArn |
No description. |
ResetAwsRdsIamRegion |
No description. |
ResetAzureIdentityAuth |
No description. |
ResetAzureTenantId |
No description. |
ResetClientcert |
No description. |
ResetConnectTimeout |
No description. |
ResetDatabase |
No description. |
ResetDatabaseUsername |
No description. |
ResetExpectedVersion |
No description. |
ResetGcpIamImpersonateServiceAccount |
No description. |
ResetHost |
No description. |
ResetMaxConnections |
No description. |
ResetPassword |
No description. |
ResetPort |
No description. |
ResetScheme |
No description. |
ResetSslmode |
No description. |
ResetSslMode |
No description. |
ResetSslrootcert |
No description. |
ResetSuperuser |
No description. |
ResetUsername |
No description. |
private string ToString()
Returns a string representation of this construct.
private void AddOverride(string Path, object Value)
- Type: string
- Type: object
private void OverrideLogicalId(string NewLogicalId)
Overrides the auto-generated logical ID with a specific ID.
- Type: string
The new logical ID to use for this stack element.
private void ResetOverrideLogicalId()
Resets a previously passed logical Id to use the auto-generated logical id again.
private object ToHclTerraform()
private object ToMetadata()
private object ToTerraform()
Adds this resource to the terraform JSON output.
private void ResetAlias()
private void ResetAwsRdsIamAuth()
private void ResetAwsRdsIamProfile()
private void ResetAwsRdsIamProviderRoleArn()
private void ResetAwsRdsIamRegion()
private void ResetAzureIdentityAuth()
private void ResetAzureTenantId()
private void ResetClientcert()
private void ResetConnectTimeout()
private void ResetDatabase()
private void ResetDatabaseUsername()
private void ResetExpectedVersion()
private void ResetGcpIamImpersonateServiceAccount()
private void ResetHost()
private void ResetMaxConnections()
private void ResetPassword()
private void ResetPort()
private void ResetScheme()
private void ResetSslmode()
private void ResetSslMode()
private void ResetSslrootcert()
private void ResetSuperuser()
private void ResetUsername()
Name | Description |
---|---|
IsConstruct |
Checks if x is a construct. |
IsTerraformElement |
No description. |
IsTerraformProvider |
No description. |
GenerateConfigForImport |
Generates CDKTF code for importing a PostgresqlProvider resource upon running "cdktf plan ". |
using HashiCorp.Cdktf.Providers.Postgresql;
PostgresqlProvider.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.
- Type: object
Any object.
using HashiCorp.Cdktf.Providers.Postgresql;
PostgresqlProvider.IsTerraformElement(object X);
- Type: object
using HashiCorp.Cdktf.Providers.Postgresql;
PostgresqlProvider.IsTerraformProvider(object X);
- Type: object
using HashiCorp.Cdktf.Providers.Postgresql;
PostgresqlProvider.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null);
Generates CDKTF code for importing a PostgresqlProvider resource upon running "cdktf plan ".
- Type: Constructs.Construct
The scope in which to define this construct.
- Type: string
The construct id used in the generated config for the PostgresqlProvider to import.
- Type: string
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
- Type: HashiCorp.Cdktf.TerraformProvider
? Optional instance of the provider where the PostgresqlProvider to import is found.
Name | Type | Description |
---|---|---|
Node |
Constructs.Node |
The tree node. |
CdktfStack |
HashiCorp.Cdktf.TerraformStack |
No description. |
Fqn |
string |
No description. |
FriendlyUniqueId |
string |
No description. |
MetaAttributes |
System.Collections.Generic.IDictionary<string, object> |
No description. |
TerraformResourceType |
string |
No description. |
TerraformGeneratorMetadata |
HashiCorp.Cdktf.TerraformProviderGeneratorMetadata |
No description. |
TerraformProviderSource |
string |
No description. |
Alias |
string |
No description. |
AliasInput |
string |
No description. |
AwsRdsIamAuthInput |
object |
No description. |
AwsRdsIamProfileInput |
string |
No description. |
AwsRdsIamProviderRoleArnInput |
string |
No description. |
AwsRdsIamRegionInput |
string |
No description. |
AzureIdentityAuthInput |
object |
No description. |
AzureTenantIdInput |
string |
No description. |
ClientcertInput |
PostgresqlProviderClientcert |
No description. |
ConnectTimeoutInput |
double |
No description. |
DatabaseInput |
string |
No description. |
DatabaseUsernameInput |
string |
No description. |
ExpectedVersionInput |
string |
No description. |
GcpIamImpersonateServiceAccountInput |
string |
No description. |
HostInput |
string |
No description. |
MaxConnectionsInput |
double |
No description. |
PasswordInput |
string |
No description. |
PortInput |
double |
No description. |
SchemeInput |
string |
No description. |
SslmodeInput |
string |
No description. |
SslModeInput |
string |
No description. |
SslrootcertInput |
string |
No description. |
SuperuserInput |
object |
No description. |
UsernameInput |
string |
No description. |
AwsRdsIamAuth |
object |
No description. |
AwsRdsIamProfile |
string |
No description. |
AwsRdsIamProviderRoleArn |
string |
No description. |
AwsRdsIamRegion |
string |
No description. |
AzureIdentityAuth |
object |
No description. |
AzureTenantId |
string |
No description. |
Clientcert |
PostgresqlProviderClientcert |
No description. |
ConnectTimeout |
double |
No description. |
Database |
string |
No description. |
DatabaseUsername |
string |
No description. |
ExpectedVersion |
string |
No description. |
GcpIamImpersonateServiceAccount |
string |
No description. |
Host |
string |
No description. |
MaxConnections |
double |
No description. |
Password |
string |
No description. |
Port |
double |
No description. |
Scheme |
string |
No description. |
Sslmode |
string |
No description. |
SslMode |
string |
No description. |
Sslrootcert |
string |
No description. |
Superuser |
object |
No description. |
Username |
string |
No description. |
public Node Node { get; }
- Type: Constructs.Node
The tree node.
public TerraformStack CdktfStack { get; }
- Type: HashiCorp.Cdktf.TerraformStack
public string Fqn { get; }
- Type: string
public string FriendlyUniqueId { get; }
- Type: string
public System.Collections.Generic.IDictionary<string, object> MetaAttributes { get; }
- Type: System.Collections.Generic.IDictionary<string, object>
public string TerraformResourceType { get; }
- Type: string
public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; }
- Type: HashiCorp.Cdktf.TerraformProviderGeneratorMetadata
public string TerraformProviderSource { get; }
- Type: string
public string Alias { get; }
- Type: string
public string AliasInput { get; }
- Type: string
public object AwsRdsIamAuthInput { get; }
- Type: object
public string AwsRdsIamProfileInput { get; }
- Type: string
public string AwsRdsIamProviderRoleArnInput { get; }
- Type: string
public string AwsRdsIamRegionInput { get; }
- Type: string
public object AzureIdentityAuthInput { get; }
- Type: object
public string AzureTenantIdInput { get; }
- Type: string
public PostgresqlProviderClientcert ClientcertInput { get; }
public double ConnectTimeoutInput { get; }
- Type: double
public string DatabaseInput { get; }
- Type: string
public string DatabaseUsernameInput { get; }
- Type: string
public string ExpectedVersionInput { get; }
- Type: string
public string GcpIamImpersonateServiceAccountInput { get; }
- Type: string
public string HostInput { get; }
- Type: string
public double MaxConnectionsInput { get; }
- Type: double
public string PasswordInput { get; }
- Type: string
public double PortInput { get; }
- Type: double
public string SchemeInput { get; }
- Type: string
public string SslmodeInput { get; }
- Type: string
public string SslModeInput { get; }
- Type: string
public string SslrootcertInput { get; }
- Type: string
public object SuperuserInput { get; }
- Type: object
public string UsernameInput { get; }
- Type: string
public object AwsRdsIamAuth { get; }
- Type: object
public string AwsRdsIamProfile { get; }
- Type: string
public string AwsRdsIamProviderRoleArn { get; }
- Type: string
public string AwsRdsIamRegion { get; }
- Type: string
public object AzureIdentityAuth { get; }
- Type: object
public string AzureTenantId { get; }
- Type: string
public PostgresqlProviderClientcert Clientcert { get; }
public double ConnectTimeout { get; }
- Type: double
public string Database { get; }
- Type: string
public string DatabaseUsername { get; }
- Type: string
public string ExpectedVersion { get; }
- Type: string
public string GcpIamImpersonateServiceAccount { get; }
- Type: string
public string Host { get; }
- Type: string
public double MaxConnections { get; }
- Type: double
public string Password { get; }
- Type: string
public double Port { get; }
- Type: double
public string Scheme { get; }
- Type: string
public string Sslmode { get; }
- Type: string
public string SslMode { get; }
- Type: string
public string Sslrootcert { get; }
- Type: string
public object Superuser { get; }
- Type: object
public string Username { get; }
- Type: string
Name | Type | Description |
---|---|---|
TfResourceType |
string |
No description. |
public string TfResourceType { get; }
- Type: string
using HashiCorp.Cdktf.Providers.Postgresql;
new PostgresqlProviderClientcert {
string Cert,
string Key,
object Sslinline = null
};
Name | Type | Description |
---|---|---|
Cert |
string |
The SSL client certificate file path. The file must contain PEM encoded data. |
Key |
string |
The SSL client certificate private key file path. The file must contain PEM encoded data. |
Sslinline |
object |
Must be set to true if you are inlining the cert/key instead of using a file path. |
public string Cert { get; set; }
- Type: string
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}
public string Key { get; set; }
- Type: string
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}
public object Sslinline { get; set; }
- Type: object
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}
using HashiCorp.Cdktf.Providers.Postgresql;
new PostgresqlProviderConfig {
string Alias = null,
object AwsRdsIamAuth = null,
string AwsRdsIamProfile = null,
string AwsRdsIamProviderRoleArn = null,
string AwsRdsIamRegion = null,
object AzureIdentityAuth = null,
string AzureTenantId = null,
PostgresqlProviderClientcert Clientcert = null,
double ConnectTimeout = null,
string Database = null,
string DatabaseUsername = null,
string ExpectedVersion = null,
string GcpIamImpersonateServiceAccount = null,
string Host = null,
double MaxConnections = null,
string Password = null,
double Port = null,
string Scheme = null,
string Sslmode = null,
string SslMode = null,
string Sslrootcert = null,
object Superuser = null,
string Username = null
};
Name | Type | Description |
---|---|---|
Alias |
string |
Alias name. |
AwsRdsIamAuth |
object |
Use rds_iam instead of password authentication (see: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html). |
AwsRdsIamProfile |
string |
AWS profile to use for IAM auth. |
AwsRdsIamProviderRoleArn |
string |
AWS IAM role to assume for IAM auth. |
AwsRdsIamRegion |
string |
AWS region to use for IAM auth. |
AzureIdentityAuth |
object |
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). |
AzureTenantId |
string |
MS Azure tenant ID (see: https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/data-sources/client_config.html). |
Clientcert |
PostgresqlProviderClientcert |
clientcert block. |
ConnectTimeout |
double |
Maximum wait for connection, in seconds. Zero or not specified means wait indefinitely. |
Database |
string |
The name of the database to connect to in order to conenct to (defaults to postgres ). |
DatabaseUsername |
string |
Database username associated to the connected user (for user name maps). |
ExpectedVersion |
string |
Specify the expected version of PostgreSQL. |
GcpIamImpersonateServiceAccount |
string |
Service account to impersonate when using GCP IAM authentication. |
Host |
string |
Name of PostgreSQL server address to connect to. |
MaxConnections |
double |
Maximum number of connections to establish to the database. Zero means unlimited. |
Password |
string |
Password to be used if the PostgreSQL server demands password authentication. |
Port |
double |
The PostgreSQL port number to connect to at the server host, or socket file name extension for Unix-domain connections. |
Scheme |
string |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs#scheme PostgresqlProvider#scheme}. |
Sslmode |
string |
This option determines whether or with what priority a secure SSL TCP/IP connection will be negotiated with the PostgreSQL server. |
SslMode |
string |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs#ssl_mode PostgresqlProvider#ssl_mode}. |
Sslrootcert |
string |
The SSL server root certificate file path. The file must contain PEM encoded data. |
Superuser |
object |
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 |
string |
PostgreSQL user name to connect as. |
public string Alias { get; set; }
- Type: string
Alias name.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs#alias PostgresqlProvider#alias}
public object AwsRdsIamAuth { get; set; }
- Type: object
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}
public string AwsRdsIamProfile { get; set; }
- Type: string
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}
public string AwsRdsIamProviderRoleArn { get; set; }
- Type: string
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}
public string AwsRdsIamRegion { get; set; }
- Type: string
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}
public object AzureIdentityAuth { get; set; }
- Type: object
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}
public string AzureTenantId { get; set; }
- Type: string
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}
public PostgresqlProviderClientcert Clientcert { get; set; }
clientcert block.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs#clientcert PostgresqlProvider#clientcert}
public double ConnectTimeout { get; set; }
- Type: double
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}
public string Database { get; set; }
- Type: string
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}
public string DatabaseUsername { get; set; }
- Type: string
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}
public string ExpectedVersion { get; set; }
- Type: string
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}
public string GcpIamImpersonateServiceAccount { get; set; }
- Type: string
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}
public string Host { get; set; }
- Type: string
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}
public double MaxConnections { get; set; }
- Type: double
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}
public string Password { get; set; }
- Type: string
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}
public double Port { get; set; }
- Type: double
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}
public string Scheme { get; set; }
- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs#scheme PostgresqlProvider#scheme}.
public string Sslmode { get; set; }
- Type: string
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}
public string SslMode { get; set; }
- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs#ssl_mode PostgresqlProvider#ssl_mode}.
public string Sslrootcert { get; set; }
- Type: string
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}
public object Superuser { get; set; }
- Type: object
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}
public string Username { get; set; }
- Type: string
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}