provider

README

provider

Refer to the Terraform Registory for docs: postgresql.

Documentation

Index

• func NewPostgresqlProvider_Override(p PostgresqlProvider, scope constructs.Construct, id *string, ...)
• func PostgresqlProvider_IsConstruct(x interface{}) *bool
• func PostgresqlProvider_IsTerraformElement(x interface{}) *bool
• func PostgresqlProvider_IsTerraformProvider(x interface{}) *bool
• func PostgresqlProvider_TfResourceType() *string
• type PostgresqlProvider
  • func NewPostgresqlProvider(scope constructs.Construct, id *string, config *PostgresqlProviderConfig) PostgresqlProvider
• type PostgresqlProviderClientcert
• type PostgresqlProviderConfig

Functions

func NewPostgresqlProvider_Override

func NewPostgresqlProvider_Override(p PostgresqlProvider, scope constructs.Construct, id *string, config *PostgresqlProviderConfig)

Create a new {@link https://www.terraform.io/docs/providers/postgresql postgresql} Resource.

func PostgresqlProvider_IsConstruct

func PostgresqlProvider_IsConstruct(x interface{}) *bool

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.

Returns: true if `x` is an object created from a class which extends `Construct`.

func PostgresqlProvider_IsTerraformElement

func PostgresqlProvider_IsTerraformElement(x interface{}) *bool

Experimental.

func PostgresqlProvider_IsTerraformProvider

func PostgresqlProvider_IsTerraformProvider(x interface{}) *bool

Experimental.

func PostgresqlProvider_TfResourceType

func PostgresqlProvider_TfResourceType() *string

Types

type PostgresqlProvider

type PostgresqlProvider interface {
	cdktf.TerraformProvider
	Alias() *string
	SetAlias(val *string)
	AliasInput() *string
	AwsRdsIamAuth() interface{}
	SetAwsRdsIamAuth(val interface{})
	AwsRdsIamAuthInput() interface{}
	AwsRdsIamProfile() *string
	SetAwsRdsIamProfile(val *string)
	AwsRdsIamProfileInput() *string
	AwsRdsIamRegion() *string
	SetAwsRdsIamRegion(val *string)
	AwsRdsIamRegionInput() *string
	// Experimental.
	CdktfStack() cdktf.TerraformStack
	Clientcert() *PostgresqlProviderClientcert
	SetClientcert(val *PostgresqlProviderClientcert)
	ClientcertInput() *PostgresqlProviderClientcert
	ConnectTimeout() *float64
	SetConnectTimeout(val *float64)
	ConnectTimeoutInput() *float64
	// Experimental.
	ConstructNodeMetadata() *map[string]interface{}
	Database() *string
	SetDatabase(val *string)
	DatabaseInput() *string
	DatabaseUsername() *string
	SetDatabaseUsername(val *string)
	DatabaseUsernameInput() *string
	ExpectedVersion() *string
	SetExpectedVersion(val *string)
	ExpectedVersionInput() *string
	// Experimental.
	Fqn() *string
	// Experimental.
	FriendlyUniqueId() *string
	Host() *string
	SetHost(val *string)
	HostInput() *string
	MaxConnections() *float64
	SetMaxConnections(val *float64)
	MaxConnectionsInput() *float64
	// Experimental.
	MetaAttributes() *map[string]interface{}
	// The tree node.
	Node() constructs.Node
	Password() *string
	SetPassword(val *string)
	PasswordInput() *string
	Port() *float64
	SetPort(val *float64)
	PortInput() *float64
	// Experimental.
	RawOverrides() interface{}
	Scheme() *string
	SetScheme(val *string)
	SchemeInput() *string
	Sslmode() *string
	SetSslmode(val *string)
	SslMode() *string
	SetSslMode(val *string)
	SslmodeInput() *string
	SslModeInput() *string
	Sslrootcert() *string
	SetSslrootcert(val *string)
	SslrootcertInput() *string
	Superuser() interface{}
	SetSuperuser(val interface{})
	SuperuserInput() interface{}
	// Experimental.
	TerraformGeneratorMetadata() *cdktf.TerraformProviderGeneratorMetadata
	// Experimental.
	TerraformProviderSource() *string
	// Experimental.
	TerraformResourceType() *string
	Username() *string
	SetUsername(val *string)
	UsernameInput() *string
	// Experimental.
	AddOverride(path *string, value interface{})
	// Overrides the auto-generated logical ID with a specific ID.
	// Experimental.
	OverrideLogicalId(newLogicalId *string)
	ResetAlias()
	ResetAwsRdsIamAuth()
	ResetAwsRdsIamProfile()
	ResetAwsRdsIamRegion()
	ResetClientcert()
	ResetConnectTimeout()
	ResetDatabase()
	ResetDatabaseUsername()
	ResetExpectedVersion()
	ResetHost()
	ResetMaxConnections()
	// Resets a previously passed logical Id to use the auto-generated logical id again.
	// Experimental.
	ResetOverrideLogicalId()
	ResetPassword()
	ResetPort()
	ResetScheme()
	ResetSslmode()
	ResetSslMode()
	ResetSslrootcert()
	ResetSuperuser()
	ResetUsername()
	SynthesizeAttributes() *map[string]interface{}
	// Experimental.
	ToMetadata() interface{}
	// Returns a string representation of this construct.
	ToString() *string
	// Adds this resource to the terraform JSON output.
	// Experimental.
	ToTerraform() interface{}
}

Represents a {@link https://www.terraform.io/docs/providers/postgresql postgresql}.

func NewPostgresqlProvider

func NewPostgresqlProvider(scope constructs.Construct, id *string, config *PostgresqlProviderConfig) PostgresqlProvider

Create a new {@link https://www.terraform.io/docs/providers/postgresql postgresql} Resource.

type PostgresqlProviderClientcert

type PostgresqlProviderClientcert struct {
	// The SSL client certificate file path. The file must contain PEM encoded data.
	//
	// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/postgresql#cert PostgresqlProvider#cert}
	Cert *string `field:"required" json:"cert" yaml:"cert"`
	// The SSL client certificate private key file path. The file must contain PEM encoded data.
	//
	// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/postgresql#key PostgresqlProvider#key}
	Key *string `field:"required" json:"key" yaml:"key"`
}

type PostgresqlProviderConfig

type PostgresqlProviderConfig struct {
	// Alias name.
	//
	// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/postgresql#alias PostgresqlProvider#alias}
	Alias *string `field:"optional" json:"alias" yaml:"alias"`
	// 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://www.terraform.io/docs/providers/postgresql#aws_rds_iam_auth PostgresqlProvider#aws_rds_iam_auth}
	AwsRdsIamAuth interface{} `field:"optional" json:"awsRdsIamAuth" yaml:"awsRdsIamAuth"`
	// AWS profile to use for IAM auth.
	//
	// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/postgresql#aws_rds_iam_profile PostgresqlProvider#aws_rds_iam_profile}
	AwsRdsIamProfile *string `field:"optional" json:"awsRdsIamProfile" yaml:"awsRdsIamProfile"`
	// AWS region to use for IAM auth.
	//
	// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/postgresql#aws_rds_iam_region PostgresqlProvider#aws_rds_iam_region}
	AwsRdsIamRegion *string `field:"optional" json:"awsRdsIamRegion" yaml:"awsRdsIamRegion"`
	// clientcert block.
	//
	// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/postgresql#clientcert PostgresqlProvider#clientcert}
	Clientcert *PostgresqlProviderClientcert `field:"optional" json:"clientcert" yaml:"clientcert"`
	// Maximum wait for connection, in seconds. Zero or not specified means wait indefinitely.
	//
	// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/postgresql#connect_timeout PostgresqlProvider#connect_timeout}
	ConnectTimeout *float64 `field:"optional" json:"connectTimeout" yaml:"connectTimeout"`
	// The name of the database to connect to in order to conenct to (defaults to `postgres`).
	//
	// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/postgresql#database PostgresqlProvider#database}
	Database *string `field:"optional" json:"database" yaml:"database"`
	// Database username associated to the connected user (for user name maps).
	//
	// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/postgresql#database_username PostgresqlProvider#database_username}
	DatabaseUsername *string `field:"optional" json:"databaseUsername" yaml:"databaseUsername"`
	// Specify the expected version of PostgreSQL.
	//
	// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/postgresql#expected_version PostgresqlProvider#expected_version}
	ExpectedVersion *string `field:"optional" json:"expectedVersion" yaml:"expectedVersion"`
	// Name of PostgreSQL server address to connect to.
	//
	// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/postgresql#host PostgresqlProvider#host}
	Host *string `field:"optional" json:"host" yaml:"host"`
	// Maximum number of connections to establish to the database. Zero means unlimited.
	//
	// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/postgresql#max_connections PostgresqlProvider#max_connections}
	MaxConnections *float64 `field:"optional" json:"maxConnections" yaml:"maxConnections"`
	// Password to be used if the PostgreSQL server demands password authentication.
	//
	// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/postgresql#password PostgresqlProvider#password}
	Password *string `field:"optional" json:"password" yaml:"password"`
	// 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://www.terraform.io/docs/providers/postgresql#port PostgresqlProvider#port}
	Port *float64 `field:"optional" json:"port" yaml:"port"`
	// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/postgresql#scheme PostgresqlProvider#scheme}.
	Scheme *string `field:"optional" json:"scheme" yaml:"scheme"`
	// 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://www.terraform.io/docs/providers/postgresql#sslmode PostgresqlProvider#sslmode}
	Sslmode *string `field:"optional" json:"sslmode" yaml:"sslmode"`
	// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/postgresql#ssl_mode PostgresqlProvider#ssl_mode}.
	SslMode *string `field:"optional" json:"sslMode" yaml:"sslMode"`
	// The SSL server root certificate file path. The file must contain PEM encoded data.
	//
	// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/postgresql#sslrootcert PostgresqlProvider#sslrootcert}
	Sslrootcert *string `field:"optional" json:"sslrootcert" yaml:"sslrootcert"`
	// 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://www.terraform.io/docs/providers/postgresql#superuser PostgresqlProvider#superuser}
	Superuser interface{} `field:"optional" json:"superuser" yaml:"superuser"`
	// PostgreSQL user name to connect as.
	//
	// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/postgresql#username PostgresqlProvider#username}
	Username *string `field:"optional" json:"username" yaml:"username"`
}