ConnectionPoolConfiguration (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.rds.model.ConnectionPoolConfiguration

All Implemented Interfaces:

Serializable, Cloneable
```
@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.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

ConnectionPoolConfiguration()

Constructors
Constructor and Description
`ConnectionPoolConfiguration()`

Method Summary

All Methods Instance Methods Concrete Methods
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()` 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)` 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)` 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.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ConnectionPoolConfiguration
```
public ConnectionPoolConfiguration()
```
- Method Detail
  - setMaxConnectionsPercent
```
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.
    
    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.
  - getMaxConnectionsPercent
```
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.
    
    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.
    
    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.
  - withMaxConnectionsPercent
```
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.
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMaxIdleConnectionsPercent
```
public void setMaxIdleConnectionsPercent(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.
    
    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.
    
    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.
  - getMaxIdleConnectionsPercent
```
public Integer getMaxIdleConnectionsPercent()
```
    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:
    
    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.
  - withMaxIdleConnectionsPercent
```
public ConnectionPoolConfiguration withMaxIdleConnectionsPercent(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.
    
    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.
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setConnectionBorrowTimeout
```
public void setConnectionBorrowTimeout(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
    
    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
  - getConnectionBorrowTimeout
```
public Integer getConnectionBorrowTimeout()
```
    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
  - withConnectionBorrowTimeout
```
public ConnectionPoolConfiguration withConnectionBorrowTimeout(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
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - getSessionPinningFilters
```
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
    
    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
  - setSessionPinningFilters
```
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
    
    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
  - withSessionPinningFilters
```
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.
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - withSessionPinningFilters
```
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
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setInitQuery
```
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
    
    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
  - getInitQuery
```
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
    
    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
  - withInitQuery
```
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
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public ConnectionPoolConfiguration clone()
```
    Overrides:
    
    clone in class Object

Did this page help you?

Class ConnectionPoolConfiguration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ConnectionPoolConfiguration

Method Detail

setMaxConnectionsPercent

getMaxConnectionsPercent

withMaxConnectionsPercent

setMaxIdleConnectionsPercent

getMaxIdleConnectionsPercent

withMaxIdleConnectionsPercent

setConnectionBorrowTimeout

getConnectionBorrowTimeout

withConnectionBorrowTimeout

getSessionPinningFilters

setSessionPinningFilters

withSessionPinningFilters

withSessionPinningFilters

setInitQuery

getInitQuery

withInitQuery

toString

equals

hashCode

clone