Interface CfnDBProxyTargetGroup.IConnectionPoolConfigurationInfoFormatProperty
Specifies the settings that control the size and behavior of the connection pool associated with a DBProxyTargetGroup
.
Namespace: Amazon.CDK.AWS.RDS
Assembly: Amazon.CDK.AWS.RDS.dll
Syntax (csharp)
public interface IConnectionPoolConfigurationInfoFormatProperty
Syntax (vb)
Public Interface IConnectionPoolConfigurationInfoFormatProperty
Remarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.RDS;
var connectionPoolConfigurationInfoFormatProperty = new ConnectionPoolConfigurationInfoFormatProperty {
ConnectionBorrowTimeout = 123,
InitQuery = "initQuery",
MaxConnectionsPercent = 123,
MaxIdleConnectionsPercent = 123,
SessionPinningFilters = new [] { "sessionPinningFilters" }
};
Synopsis
Properties
ConnectionBorrowTimeout | The number of seconds for a proxy to wait for a connection to become available in the connection pool. |
InitQuery | One or more SQL statements for the proxy to run when opening each new database connection. |
MaxConnectionsPercent | The maximum size of the connection pool for each target in a target group. |
MaxIdleConnectionsPercent | Controls how actively the proxy closes idle database connections in the connection pool. |
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. |
Properties
ConnectionBorrowTimeout
The number of seconds for a proxy to wait for a connection to become available in the connection pool.
virtual Nullable<double> ConnectionBorrowTimeout { get; }
Property Value
System.Nullable<System.Double>
Remarks
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
InitQuery
One or more SQL statements for the proxy to run when opening each new database connection.
virtual string InitQuery { get; }
Property Value
System.String
Remarks
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
MaxConnectionsPercent
The maximum size of the connection pool for each target in a target group.
virtual Nullable<double> MaxConnectionsPercent { get; }
Property Value
System.Nullable<System.Double>
Remarks
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.
MaxIdleConnectionsPercent
Controls how actively the proxy closes idle database connections in the connection pool.
virtual Nullable<double> MaxIdleConnectionsPercent { get; }
Property Value
System.Nullable<System.Double>
Remarks
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
.
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.
virtual string[] SessionPinningFilters { get; }
Property Value
System.String[]
Remarks
Including an item in the list exempts that class of SQL operations from the pinning behavior.
Default: no session pinning filters