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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-rds/types.rb

Overview

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#connection_borrow_timeoutInteger

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: ‘120`

Constraints:

  • Must be between 0 and 3600.

^

Returns:

  • (Integer)


1046
1047
1048
1049
1050
1051
1052
1053
1054
# File 'lib/aws-sdk-rds/types.rb', line 1046

class ConnectionPoolConfiguration < Struct.new(
  :max_connections_percent,
  :max_idle_connections_percent,
  :connection_borrow_timeout,
  :session_pinning_filters,
  :init_query)
  SENSITIVE = []
  include Aws::Structure
end

#init_queryString

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)


1046
1047
1048
1049
1050
1051
1052
1053
1054
# File 'lib/aws-sdk-rds/types.rb', line 1046

class ConnectionPoolConfiguration < Struct.new(
  :max_connections_percent,
  :max_idle_connections_percent,
  :connection_borrow_timeout,
  :session_pinning_filters,
  :init_query)
  SENSITIVE = []
  include Aws::Structure
end

#max_connections_percentInteger

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.

^

Returns:

  • (Integer)


1046
1047
1048
1049
1050
1051
1052
1053
1054
# File 'lib/aws-sdk-rds/types.rb', line 1046

class ConnectionPoolConfiguration < Struct.new(
  :max_connections_percent,
  :max_idle_connections_percent,
  :connection_borrow_timeout,
  :session_pinning_filters,
  :init_query)
  SENSITIVE = []
  include Aws::Structure
end

#max_idle_connections_percentInteger

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_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`.

^

Returns:

  • (Integer)


1046
1047
1048
1049
1050
1051
1052
1053
1054
# File 'lib/aws-sdk-rds/types.rb', line 1046

class ConnectionPoolConfiguration < Struct.new(
  :max_connections_percent,
  :max_idle_connections_percent,
  :connection_borrow_timeout,
  :session_pinning_filters,
  :init_query)
  SENSITIVE = []
  include Aws::Structure
end

#session_pinning_filtersArray<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>)


1046
1047
1048
1049
1050
1051
1052
1053
1054
# File 'lib/aws-sdk-rds/types.rb', line 1046

class ConnectionPoolConfiguration < Struct.new(
  :max_connections_percent,
  :max_idle_connections_percent,
  :connection_borrow_timeout,
  :session_pinning_filters,
  :init_query)
  SENSITIVE = []
  include Aws::Structure
end