Header menu logo FsCDK

DatabaseProxyBuilder Type

Constructors

Constructor Description

DatabaseProxyBuilder(name)

Full Usage: DatabaseProxyBuilder(name)

Parameters:
    name : string

Returns: DatabaseProxyBuilder
name : string
Returns: DatabaseProxyBuilder

Instance members

Instance member Description

borrowTimeout timeout

Full Usage: borrowTimeout timeout

Parameters:
Returns: DatabaseProxyConfig

Sets the maximum time a connection can be borrowed before being returned.

timeout : Duration
Returns: DatabaseProxyConfig

this.Combine

Full Usage: this.Combine

Parameters:
Returns: DatabaseProxyConfig
state1 : DatabaseProxyConfig
state2 : DatabaseProxyConfig
Returns: DatabaseProxyConfig

constructId id

Full Usage: constructId id

Parameters:
    id : string

Returns: DatabaseProxyConfig

Sets a custom construct ID.

id : string
Returns: DatabaseProxyConfig

dbProxyName name

Full Usage: dbProxyName name

Parameters:
    name : string

Returns: DatabaseProxyConfig

Sets the DB proxy name.

name : string
Returns: DatabaseProxyConfig

debugLogging enabled

Full Usage: debugLogging enabled

Parameters:
    enabled : bool

Returns: DatabaseProxyConfig

Enables or disables debug logging.

enabled : bool
Returns: DatabaseProxyConfig

this.Delay

Full Usage: this.Delay

Parameters:
Returns: DatabaseProxyConfig
Modifiers: inline
f : unit -> DatabaseProxyConfig
Returns: DatabaseProxyConfig

this.For

Full Usage: this.For

Parameters:
Returns: DatabaseProxyConfig
Modifiers: inline
config : DatabaseProxyConfig
f : unit -> DatabaseProxyConfig
Returns: DatabaseProxyConfig

iamAuth enabled

Full Usage: iamAuth enabled

Parameters:
    enabled : bool

Returns: DatabaseProxyConfig

Enables or disables IAM authentication.

enabled : bool
Returns: DatabaseProxyConfig

idleClientTimeout timeout

Full Usage: idleClientTimeout timeout

Parameters:
Returns: DatabaseProxyConfig

Sets the idle client timeout.

timeout : Duration
Returns: DatabaseProxyConfig

maxConnectionsPercent percent

Full Usage: maxConnectionsPercent percent

Parameters:
    percent : int

Returns: DatabaseProxyConfig

Sets the maximum percentage of database connections to use.

percent : int
Returns: DatabaseProxyConfig

maxIdleConnectionsPercent percent

Full Usage: maxIdleConnectionsPercent percent

Parameters:
    percent : int

Returns: DatabaseProxyConfig

Sets the maximum percentage of idle connections.

percent : int
Returns: DatabaseProxyConfig

proxyTarget cluster

Full Usage: proxyTarget cluster

Parameters:
Returns: DatabaseProxyConfig

Sets the proxy target to a database cluster.

cluster : IDatabaseCluster
Returns: DatabaseProxyConfig

proxyTarget instance

Full Usage: proxyTarget instance

Parameters:
Returns: DatabaseProxyConfig

Sets the proxy target to a database instance.

instance : IDatabaseInstance
Returns: DatabaseProxyConfig

requireTLS require

Full Usage: requireTLS require

Parameters:
    require : bool

Returns: DatabaseProxyConfig

Requires TLS for connections.

require : bool
Returns: DatabaseProxyConfig

this.Run

Full Usage: this.Run

Parameters:
Returns: DatabaseProxySpec
config : DatabaseProxyConfig
Returns: DatabaseProxySpec

secret secret

Full Usage: secret secret

Parameters:
Returns: DatabaseProxyConfig

Adds a secret for database credentials.

secret : ISecret
Returns: DatabaseProxyConfig

secrets secrets

Full Usage: secrets secrets

Parameters:
Returns: DatabaseProxyConfig

Adds multiple secrets for database credentials.

secrets : ISecret list
Returns: DatabaseProxyConfig

securityGroup sg

Full Usage: securityGroup sg

Parameters:
Returns: DatabaseProxyConfig

Adds a security group to the proxy.

sg : ISecurityGroup
Returns: DatabaseProxyConfig

securityGroups sgs

Full Usage: securityGroups sgs

Parameters:
Returns: DatabaseProxyConfig

Adds multiple security groups to the proxy.

sgs : ISecurityGroup list
Returns: DatabaseProxyConfig

vpc vpc

Full Usage: vpc vpc

Parameters:
Returns: DatabaseProxyConfig

Sets the VPC for the proxy.

vpc : IVpc
Returns: DatabaseProxyConfig

vpcSubnets subnets

Full Usage: vpcSubnets subnets

Parameters:
Returns: DatabaseProxyConfig

Sets the VPC subnets for the proxy.

subnets : SubnetSelection
Returns: DatabaseProxyConfig

this.Yield

Full Usage: this.Yield

Parameters:
    () : unit

Returns: DatabaseProxyConfig
() : unit
Returns: DatabaseProxyConfig

this.Zero

Full Usage: this.Zero

Returns: DatabaseProxyConfig
Returns: DatabaseProxyConfig

Type something to start searching.