@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class ConnectionPoolConfiguration extends Object implements Serializable, Cloneable
Specifies the settings that control the size and behavior of the connection pool associated with a
DBProxyTargetGroup.
| Constructor and Description |
|---|
ConnectionPoolConfiguration() |
| Modifier and Type | Method and Description |
|---|---|
ConnectionPoolConfiguration |
clone() |
boolean |
equals(Object obj) |
Integer |
getConnectionBorrowTimeout()
The number of seconds for a proxy to wait for a connection to become available in the connection pool.
|
String |
getInitQuery()
One or more SQL statements for the proxy to run when opening each new database connection.
|
Integer |
getMaxConnectionsPercent()
The maximum size of the connection pool for each target in a target group.
|
Integer |
getMaxIdleConnectionsPercent()
A value that controls how actively the proxy closes idle database connections in the connection pool.
|
List<String> |
getSessionPinningFilters()
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.
|
int |
hashCode() |
void |
setConnectionBorrowTimeout(Integer connectionBorrowTimeout)
The number of seconds for a proxy to wait for a connection to become available in the connection pool.
|
void |
setInitQuery(String initQuery)
One or more SQL statements for the proxy to run when opening each new database connection.
|
void |
setMaxConnectionsPercent(Integer maxConnectionsPercent)
The maximum size of the connection pool for each target in a target group.
|
void |
setMaxIdleConnectionsPercent(Integer maxIdleConnectionsPercent)
A value that controls how actively the proxy closes idle database connections in the connection pool.
|
void |
setSessionPinningFilters(Collection<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.
|
String |
toString()
Returns a string representation of this object.
|
ConnectionPoolConfiguration |
withConnectionBorrowTimeout(Integer connectionBorrowTimeout)
The number of seconds for a proxy to wait for a connection to become available in the connection pool.
|
ConnectionPoolConfiguration |
withInitQuery(String initQuery)
One or more SQL statements for the proxy to run when opening each new database connection.
|
ConnectionPoolConfiguration |
withMaxConnectionsPercent(Integer maxConnectionsPercent)
The maximum size of the connection pool for each target in a target group.
|
ConnectionPoolConfiguration |
withMaxIdleConnectionsPercent(Integer maxIdleConnectionsPercent)
A value that controls how actively the proxy closes idle database connections in the connection pool.
|
ConnectionPoolConfiguration |
withSessionPinningFilters(Collection<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 |
withSessionPinningFilters(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.
|
public void setMaxConnectionsPercent(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.
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.
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.
public Integer getMaxConnectionsPercent()
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.
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.
public ConnectionPoolConfiguration withMaxConnectionsPercent(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.
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.
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.
public void setMaxIdleConnectionsPercent(Integer maxIdleConnectionsPercent)
A value that 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.
maxIdleConnectionsPercent - A value that 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.
public Integer getMaxIdleConnectionsPercent()
A value that 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.
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.
public ConnectionPoolConfiguration withMaxIdleConnectionsPercent(Integer maxIdleConnectionsPercent)
A value that 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.
maxIdleConnectionsPercent - A value that 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.
public void setConnectionBorrowTimeout(Integer connectionBorrowTimeout)
The number of seconds for a proxy to wait for a connection to become available in the connection pool. This
setting only applies when the proxy has opened its maximum number of connections and all connections are busy
with client sessions. For an unlimited wait time, specify 0.
Default: 120
Constraints:
Must be between 0 and 3600.
connectionBorrowTimeout - The number of seconds for a proxy to wait for a connection to become available in the connection pool.
This setting only applies when the proxy has opened its maximum number of connections and all connections
are busy with client sessions. For an unlimited wait time, specify 0.
Default: 120
Constraints:
Must be between 0 and 3600.
public Integer getConnectionBorrowTimeout()
The number of seconds for a proxy to wait for a connection to become available in the connection pool. This
setting only applies when the proxy has opened its maximum number of connections and all connections are busy
with client sessions. For an unlimited wait time, specify 0.
Default: 120
Constraints:
Must be between 0 and 3600.
0.
Default: 120
Constraints:
Must be between 0 and 3600.
public ConnectionPoolConfiguration withConnectionBorrowTimeout(Integer connectionBorrowTimeout)
The number of seconds for a proxy to wait for a connection to become available in the connection pool. This
setting only applies when the proxy has opened its maximum number of connections and all connections are busy
with client sessions. For an unlimited wait time, specify 0.
Default: 120
Constraints:
Must be between 0 and 3600.
connectionBorrowTimeout - The number of seconds for a proxy to wait for a connection to become available in the connection pool.
This setting only applies when the proxy has opened its maximum number of connections and all connections
are busy with client sessions. For an unlimited wait time, specify 0.
Default: 120
Constraints:
Must be between 0 and 3600.
public List<String> getSessionPinningFilters()
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
Default: no session pinning filters
public void setSessionPinningFilters(Collection<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
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
public ConnectionPoolConfiguration withSessionPinningFilters(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
NOTE: This method appends the values to the existing list (if any). Use
setSessionPinningFilters(java.util.Collection) or
withSessionPinningFilters(java.util.Collection) if you want to override the existing values.
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
public ConnectionPoolConfiguration withSessionPinningFilters(Collection<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
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
public void setInitQuery(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
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
public String getInitQuery()
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 withInitQuery(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
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
public String toString()
toString in class ObjectObject.toString()public ConnectionPoolConfiguration clone()