Package software.amazon.awscdk.services.rds

Class CfnDBProxyTargetGroup.ConnectionPoolConfigurationInfoFormatProperty.Builder

java.lang.Object

software.amazon.awscdk.services.rds.CfnDBProxyTargetGroup.ConnectionPoolConfigurationInfoFormatProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnDBProxyTargetGroup.ConnectionPoolConfigurationInfoFormatProperty>

Enclosing interface:

CfnDBProxyTargetGroup.ConnectionPoolConfigurationInfoFormatProperty

@Stability(Stable)
public static final class CfnDBProxyTargetGroup.ConnectionPoolConfigurationInfoFormatProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnDBProxyTargetGroup.ConnectionPoolConfigurationInfoFormatProperty>

A builder for CfnDBProxyTargetGroup.ConnectionPoolConfigurationInfoFormatProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnDBProxyTargetGroup.ConnectionPoolConfigurationInfoFormatProperty	build()	Builds the configured instance.
CfnDBProxyTargetGroup.ConnectionPoolConfigurationInfoFormatProperty.Builder	connectionBorrowTimeout(Number connectionBorrowTimeout)	Sets the value of CfnDBProxyTargetGroup.ConnectionPoolConfigurationInfoFormatProperty.getConnectionBorrowTimeout()
CfnDBProxyTargetGroup.ConnectionPoolConfigurationInfoFormatProperty.Builder	initQuery(String initQuery)	Sets the value of CfnDBProxyTargetGroup.ConnectionPoolConfigurationInfoFormatProperty.getInitQuery()
CfnDBProxyTargetGroup.ConnectionPoolConfigurationInfoFormatProperty.Builder	maxConnectionsPercent(Number maxConnectionsPercent)	Sets the value of CfnDBProxyTargetGroup.ConnectionPoolConfigurationInfoFormatProperty.getMaxConnectionsPercent()
CfnDBProxyTargetGroup.ConnectionPoolConfigurationInfoFormatProperty.Builder	maxIdleConnectionsPercent(Number maxIdleConnectionsPercent)	Sets the value of CfnDBProxyTargetGroup.ConnectionPoolConfigurationInfoFormatProperty.getMaxIdleConnectionsPercent()
CfnDBProxyTargetGroup.ConnectionPoolConfigurationInfoFormatProperty.Builder	sessionPinningFilters(List<String> sessionPinningFilters)	Sets the value of CfnDBProxyTargetGroup.ConnectionPoolConfigurationInfoFormatProperty.getSessionPinningFilters()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

connectionBorrowTimeout

@Stability(Stable)
public CfnDBProxyTargetGroup.ConnectionPoolConfigurationInfoFormatProperty.Builder connectionBorrowTimeout(Number connectionBorrowTimeout)

Sets the value of CfnDBProxyTargetGroup.ConnectionPoolConfigurationInfoFormatProperty.getConnectionBorrowTimeout()

Parameters:

connectionBorrowTimeout - The number of seconds for a proxy to wait for a connection to become available in the connection pool. Only applies when the proxy has opened its maximum number of connections and all connections are busy with client sessions.

Default: 120

Constraints: between 1 and 3600, or 0 representing unlimited

Returns:

this

initQuery

@Stability(Stable)
public CfnDBProxyTargetGroup.ConnectionPoolConfigurationInfoFormatProperty.Builder initQuery(String initQuery)

Sets the value of CfnDBProxyTargetGroup.ConnectionPoolConfigurationInfoFormatProperty.getInitQuery()

Parameters:

initQuery - One or more SQL statements for the proxy to run when opening each new database connection. Typically used with SET statements to make sure that each connection has identical settings such as time zone and character set. For multiple statements, use semicolons as the separator. You can also include multiple variables in a single SET statement, such as SET x=1, y=2 .

Default: no initialization query

Returns:

this

maxConnectionsPercent

@Stability(Stable)
public CfnDBProxyTargetGroup.ConnectionPoolConfigurationInfoFormatProperty.Builder maxConnectionsPercent(Number maxConnectionsPercent)

Sets the value of CfnDBProxyTargetGroup.ConnectionPoolConfigurationInfoFormatProperty.getMaxConnectionsPercent()

Parameters:

maxConnectionsPercent - The maximum size of the connection pool for each target in a target group. The value is expressed as a percentage of the max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group.

If you specify MaxIdleConnectionsPercent , then you must also include a value for this parameter.

Default: 10 for RDS for Microsoft SQL Server, and 100 for all other engines

Constraints: Must be between 1 and 100.

Returns:

this

maxIdleConnectionsPercent

@Stability(Stable)
public CfnDBProxyTargetGroup.ConnectionPoolConfigurationInfoFormatProperty.Builder maxIdleConnectionsPercent(Number maxIdleConnectionsPercent)

Sets the value of CfnDBProxyTargetGroup.ConnectionPoolConfigurationInfoFormatProperty.getMaxIdleConnectionsPercent()

Parameters:

maxIdleConnectionsPercent - Controls how actively the proxy closes idle database connections in the connection pool. The value is expressed as a percentage of the max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group. With a high value, the proxy leaves a high percentage of idle database connections open. A low value causes the proxy to close more idle connections and return them to the database.

If you specify this parameter, then you must also include a value for MaxConnectionsPercent .

Default: The default value is half of the value of MaxConnectionsPercent . For example, if MaxConnectionsPercent is 80, then the default value of MaxIdleConnectionsPercent is 40. If the value of MaxConnectionsPercent isn't specified, then for SQL Server, MaxIdleConnectionsPercent is 5, and for all other engines, the default is 50.

Constraints: Must be between 0 and the value of MaxConnectionsPercent .

Returns:

this

sessionPinningFilters

@Stability(Stable)
public CfnDBProxyTargetGroup.ConnectionPoolConfigurationInfoFormatProperty.Builder sessionPinningFilters(List<String> sessionPinningFilters)

Sets the value of CfnDBProxyTargetGroup.ConnectionPoolConfigurationInfoFormatProperty.getSessionPinningFilters()

Parameters:

sessionPinningFilters - Each item in the list represents a class of SQL operations that normally cause all later statements in a session using a proxy to be pinned to the same underlying database connection. Including an item in the list exempts that class of SQL operations from the pinning behavior.

Default: no session pinning filters

Returns:

this

build

@Stability(Stable)
public CfnDBProxyTargetGroup.ConnectionPoolConfigurationInfoFormatProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnDBProxyTargetGroup.ConnectionPoolConfigurationInfoFormatProperty>

Returns:

a new instance of CfnDBProxyTargetGroup.ConnectionPoolConfigurationInfoFormatProperty

Throws:

NullPointerException - if any required attribute was not provided