ConnectionPoolConfigurationInfo (AWS SDK for Java

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

All Implemented Interfaces:

Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ConnectionPoolConfigurationInfo
extends Object
implements Serializable, Cloneable
```
Displays the settings that control the size and behavior of the connection pool associated with a DBProxyTarget.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

ConnectionPoolConfigurationInfo()

Constructors
Constructor and Description
`ConnectionPoolConfigurationInfo()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ConnectionPoolConfigurationInfo`	`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.
`ConnectionPoolConfigurationInfo`	`withConnectionBorrowTimeout(Integer connectionBorrowTimeout)` The number of seconds for a proxy to wait for a connection to become available in the connection pool.
`ConnectionPoolConfigurationInfo`	`withInitQuery(String initQuery)` One or more SQL statements for the proxy to run when opening each new database connection.
`ConnectionPoolConfigurationInfo`	`withMaxConnectionsPercent(Integer maxConnectionsPercent)` The maximum size of the connection pool for each target in a target group.
`ConnectionPoolConfigurationInfo`	`withMaxIdleConnectionsPercent(Integer maxIdleConnectionsPercent)` Controls how actively the proxy closes idle database connections in the connection pool.
`ConnectionPoolConfigurationInfo`	`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.
`ConnectionPoolConfigurationInfo`	`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
  - ConnectionPoolConfigurationInfo
```
public ConnectionPoolConfigurationInfo()
```
- Method Detail
  - setMaxConnectionsPercent
```
public void setMaxConnectionsPercent(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.
    
    Parameters:
    
    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.
  - getMaxConnectionsPercent
```
public Integer getMaxConnectionsPercent()
```
    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.
    
    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.
  - withMaxConnectionsPercent
```
public ConnectionPoolConfigurationInfo withMaxConnectionsPercent(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.
    
    Parameters:
    
    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.
    
    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. 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.
    
    Parameters:
    
    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.
  - getMaxIdleConnectionsPercent
```
public Integer getMaxIdleConnectionsPercent()
```
    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.
    
    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.
  - withMaxIdleConnectionsPercent
```
public ConnectionPoolConfigurationInfo withMaxIdleConnectionsPercent(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.
    
    Parameters:
    
    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.
    
    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.
    
    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.
  - 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.
    
    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.
  - withConnectionBorrowTimeout
```
public ConnectionPoolConfigurationInfo 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.
    
    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.
    
    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. Currently, the only allowed value is EXCLUDE_VARIABLE_SETS.
    
    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.
  - 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. Currently, the only allowed value is EXCLUDE_VARIABLE_SETS.
    
    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. Currently, the only allowed value is EXCLUDE_VARIABLE_SETS.
  - withSessionPinningFilters
```
public ConnectionPoolConfigurationInfo 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. Currently, the only allowed value is EXCLUDE_VARIABLE_SETS.
    
    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. Currently, the only allowed value is EXCLUDE_VARIABLE_SETS.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withSessionPinningFilters
```
public ConnectionPoolConfigurationInfo 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. Currently, the only allowed value is EXCLUDE_VARIABLE_SETS.
    
    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. Currently, the only allowed value is EXCLUDE_VARIABLE_SETS.
    
    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. 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.
    
    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. 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.
  - 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. 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.
  - withInitQuery
```
public ConnectionPoolConfigurationInfo 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. 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.
    
    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. 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:
    
    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 ConnectionPoolConfigurationInfo clone()
```
    Overrides:
    
    clone in class Object

Did this page help you?

Class ConnectionPoolConfigurationInfo

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ConnectionPoolConfigurationInfo

Method Detail

setMaxConnectionsPercent

getMaxConnectionsPercent

withMaxConnectionsPercent

setMaxIdleConnectionsPercent

getMaxIdleConnectionsPercent

withMaxIdleConnectionsPercent

setConnectionBorrowTimeout

getConnectionBorrowTimeout

withConnectionBorrowTimeout

getSessionPinningFilters

setSessionPinningFilters

withSessionPinningFilters

withSessionPinningFilters

setInitQuery

getInitQuery

withInitQuery

toString

equals

hashCode

clone