Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Synopsis
- data ConnectionPoolConfiguration = ConnectionPoolConfiguration' {}
- newConnectionPoolConfiguration :: ConnectionPoolConfiguration
- connectionPoolConfiguration_connectionBorrowTimeout :: Lens' ConnectionPoolConfiguration (Maybe Int)
- connectionPoolConfiguration_initQuery :: Lens' ConnectionPoolConfiguration (Maybe Text)
- connectionPoolConfiguration_maxConnectionsPercent :: Lens' ConnectionPoolConfiguration (Maybe Int)
- connectionPoolConfiguration_maxIdleConnectionsPercent :: Lens' ConnectionPoolConfiguration (Maybe Int)
- connectionPoolConfiguration_sessionPinningFilters :: Lens' ConnectionPoolConfiguration (Maybe [Text])
Documentation
data ConnectionPoolConfiguration Source #
Specifies the settings that control the size and behavior of the
connection pool associated with a DBProxyTargetGroup
.
See: newConnectionPoolConfiguration
smart constructor.
ConnectionPoolConfiguration' | |
|
Instances
newConnectionPoolConfiguration :: ConnectionPoolConfiguration Source #
Create a value of ConnectionPoolConfiguration
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:connectionBorrowTimeout:ConnectionPoolConfiguration'
, connectionPoolConfiguration_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
$sel:initQuery:ConnectionPoolConfiguration'
, connectionPoolConfiguration_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
$sel:maxConnectionsPercent:ConnectionPoolConfiguration'
, connectionPoolConfiguration_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.
$sel:maxIdleConnectionsPercent:ConnectionPoolConfiguration'
, connectionPoolConfiguration_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
.
$sel:sessionPinningFilters:ConnectionPoolConfiguration'
, connectionPoolConfiguration_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
connectionPoolConfiguration_connectionBorrowTimeout :: Lens' ConnectionPoolConfiguration (Maybe Int) Source #
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
connectionPoolConfiguration_initQuery :: Lens' ConnectionPoolConfiguration (Maybe Text) Source #
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
connectionPoolConfiguration_maxConnectionsPercent :: Lens' ConnectionPoolConfiguration (Maybe Int) Source #
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.
connectionPoolConfiguration_maxIdleConnectionsPercent :: Lens' ConnectionPoolConfiguration (Maybe Int) Source #
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
.
connectionPoolConfiguration_sessionPinningFilters :: Lens' ConnectionPoolConfiguration (Maybe [Text]) Source #
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