Interface CfnDBProxyTargetGroup.ConnectionPoolConfigurationInfoFormatProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnDBProxyTargetGroup.ConnectionPoolConfigurationInfoFormatProperty.Jsii$Proxy
- Enclosing class:
CfnDBProxyTargetGroup
DBProxyTargetGroup .
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.rds.*;
ConnectionPoolConfigurationInfoFormatProperty connectionPoolConfigurationInfoFormatProperty = ConnectionPoolConfigurationInfoFormatProperty.builder()
.connectionBorrowTimeout(123)
.initQuery("initQuery")
.maxConnectionsPercent(123)
.maxIdleConnectionsPercent(123)
.sessionPinningFilters(List.of("sessionPinningFilters"))
.build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classstatic final classAn implementation forCfnDBProxyTargetGroup.ConnectionPoolConfigurationInfoFormatProperty -
Method Summary
Modifier and TypeMethodDescriptionbuilder()default NumberThe number of seconds for a proxy to wait for a connection to become available in the connection pool.default StringOne or more SQL statements for the proxy to run when opening each new database connection.default NumberThe maximum size of the connection pool for each target in a target group.default NumberA value that controls how actively the proxy closes idle database connections in the connection pool.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 interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
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:
120Constraints:
- Must be between 0 and 3600.
- See Also:
-
getInitQuery
One or more SQL statements for the proxy to run when opening each new database connection.Typically used with
SETstatements 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 singleSETstatement, such asSET x=1, y=2.Default: no initialization query
- See Also:
-
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_connectionssetting 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:
10for RDS for Microsoft SQL Server, and100for all other enginesConstraints:
- Must be between 1 and 100.
- See Also:
-
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_connectionssetting 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, ifMaxConnectionsPercentis 80, then the default value ofMaxIdleConnectionsPercentis 40. If the value ofMaxConnectionsPercentisn't specified, then for SQL Server,MaxIdleConnectionsPercentis5, and for all other engines, the default is50.Constraints:
- Must be between 0 and the value of
MaxConnectionsPercent.
- See Also:
- Must be between 0 and the value of
-
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
- See Also:
-
builder
@Stability(Stable) static CfnDBProxyTargetGroup.ConnectionPoolConfigurationInfoFormatProperty.Builder builder()
-