@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.
| Modifier and Type | Class and Description |
|---|---|
static interface |
ConnectionPoolConfiguration.Builder |
| 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()
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 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.
|
clone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic 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.
Default: 100
Constraints: between 1 and 100
max_connections setting for the RDS DB instance or Aurora DB cluster used
by the target group.
Default: 100
Constraints: between 1 and 100
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.
Default: 50
Constraints: between 0 and MaxConnectionsPercent
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.
Default: 50
Constraints: between 0 and MaxConnectionsPercent
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
Default: 120
Constraints: between 1 and 3600, or 0 representing unlimited
public final boolean hasSessionPinningFilters()
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.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.
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.
Default: no session pinning filters
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
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
public ConnectionPoolConfiguration.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<ConnectionPoolConfiguration.Builder,ConnectionPoolConfiguration>public static ConnectionPoolConfiguration.Builder builder()
public static Class<? extends ConnectionPoolConfiguration.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
Copyright © 2022. All rights reserved.