You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::RDS::Types::ConnectionPoolConfiguration

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing ConnectionPoolConfiguration as input to an Aws::Client method, you can use a vanilla Hash:

{
  max_connections_percent: 1,
  max_idle_connections_percent: 1,
  connection_borrow_timeout: 1,
  session_pinning_filters: ["String"],
  init_query: "String",
}

Specifies the settings that control the size and behavior of the connection pool associated with a DBProxyTargetGroup.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#connection_borrow_timeout ⇒ Integer

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:

  • (Integer) —

    The number of seconds for a proxy to wait for a connection to become available in the connection pool.

#init_query ⇒ String

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:

  • (String) —

    One or more SQL statements for the proxy to run when opening each new database connection.

#max_connections_percent ⇒ Integer

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.

Default: 100

Constraints: between 1 and 100

Returns:

  • (Integer) —

    The maximum size of the connection pool for each target in a target group.

#max_idle_connections_percent ⇒ Integer

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.

Default: 50

Constraints: between 0 and MaxConnectionsPercent

Returns:

  • (Integer) —

    Controls how actively the proxy closes idle database connections in the connection pool.

#session_pinning_filters ⇒ Array<String>

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:

  • (Array<String>) —

    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.