software.amazon.awssdk.services.rds.model

Class ConnectionPoolConfigurationInfo

java.lang.Object

software.amazon.awssdk.services.rds.model.ConnectionPoolConfigurationInfo

All Implemented Interfaces:

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

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

Displays the settings that control the size and behavior of the connection pool associated with a DBProxyTarget.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ConnectionPoolConfigurationInfo.Builder

Method Summary

Modifier and Type	Method and Description
static ConnectionPoolConfigurationInfo.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() For responses, this returns true if the service returned a value for the SessionPinningFilters property.
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 ConnectionPoolConfigurationInfo.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.
ConnectionPoolConfigurationInfo.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. 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.

Returns:

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.

maxIdleConnectionsPercent

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

Returns:

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.

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.

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.

hasSessionPinningFilters

public final boolean hasSessionPinningFilters()

For responses, this returns true if the service returned a value for the SessionPinningFilters property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

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. Currently, the only allowed value is EXCLUDE_VARIABLE_SETS.

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

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSessionPinningFilters() method.

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. Currently, the only allowed value is EXCLUDE_VARIABLE_SETS.

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. This setting is empty by default. 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.

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. This setting is empty by default. 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.

toBuilder

public ConnectionPoolConfigurationInfo.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ConnectionPoolConfigurationInfo.Builder,ConnectionPoolConfigurationInfo>

builder

public static ConnectionPoolConfigurationInfo.Builder builder()

serializableBuilderClass

public static Class<? extends ConnectionPoolConfigurationInfo.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