software.amazon.awssdk.services.rds.model

Class ConnectionPoolConfiguration

java.lang.Object

software.amazon.awssdk.services.rds.model.ConnectionPoolConfiguration

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ConnectionPoolConfiguration.Builder,ConnectionPoolConfiguration>

@Generated(value="software.amazon.awssdk:codegen")
public final class ConnectionPoolConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ConnectionPoolConfiguration.Builder,ConnectionPoolConfiguration>

Specifies the settings that control the size and behavior of the connection pool associated with a DBProxyTargetGroup.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ConnectionPoolConfiguration.Builder

Method Summary

Modifier and Type	Method and Description
static ConnectionPoolConfiguration.Builder	builder()
Integer	connectionBorrowTimeout() The number of seconds for a proxy to wait for a connection to become available in the connection pool.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasSessionPinningFilters() Returns true if the SessionPinningFilters property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
String	initQuery() One or more SQL statements for the proxy to run when opening each new database connection.
Integer	maxConnectionsPercent() The maximum size of the connection pool for each target in a target group.
Integer	maxIdleConnectionsPercent() Controls how actively the proxy closes idle database connections in the connection pool.
List<SdkField<?>>	sdkFields()
static Class<? extends ConnectionPoolConfiguration.Builder>	serializableBuilderClass()
List<String>	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.
ConnectionPoolConfiguration.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

maxConnectionsPercent

public final Integer maxConnectionsPercent()

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

Default: 100

Constraints: between 1 and 100

Returns:

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

Default: 100

Constraints: between 1 and 100

maxIdleConnectionsPercent

public final Integer maxIdleConnectionsPercent()

Controls how actively the proxy closes idle database connections in the connection pool. A high value enables the proxy to leave a high percentage of idle connections open. A low value causes the proxy to close idle client connections and return the underlying database connections to the connection pool. For Aurora MySQL, it is expressed as a percentage of the max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group.

Default: 50

Constraints: between 0 and MaxConnectionsPercent

Returns:

Controls how actively the proxy closes idle database connections in the connection pool. A high value enables the proxy to leave a high percentage of idle connections open. A low value causes the proxy to close idle client connections and return the underlying database connections to the connection pool. For Aurora MySQL, it is expressed as a percentage of the max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group.

Default: 50

Constraints: between 0 and MaxConnectionsPercent

connectionBorrowTimeout

public final Integer 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:

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

hasSessionPinningFilters

public final boolean hasSessionPinningFilters()

Returns true if the SessionPinningFilters property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

sessionPinningFilters

public final List<String> 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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasSessionPinningFilters() to see if a value was sent in this field.

Returns:

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

initQuery

public final String 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:

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

toBuilder

public ConnectionPoolConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ConnectionPoolConfiguration.Builder,ConnectionPoolConfiguration>

builder

public static ConnectionPoolConfiguration.Builder builder()

serializableBuilderClass

public static Class<? extends ConnectionPoolConfiguration.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo