Amazonka.RDS.Types.ConnectionPoolConfigurationInfo

Documentation

data ConnectionPoolConfigurationInfo

Displays the settings that control the size and behavior of the connection pool associated with a DBProxyTarget.

See: newConnectionPoolConfigurationInfo smart constructor.

Constructors

ConnectionPoolConfigurationInfo'

Fields

• connectionBorrowTimeout :: Maybe Int

  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.

• initQuery :: Maybe Text

  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. This setting is empty by default. 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.

• maxConnectionsPercent :: Maybe Int

  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.

• maxIdleConnectionsPercent :: Maybe Int

  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.

• sessionPinningFilters :: Maybe [Text]

  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. This setting is only supported for MySQL engine family databases. Currently, the only allowed value is EXCLUDE_VARIABLE_SETS.

Instances

FromXML ConnectionPoolConfigurationInfo

Defined in Amazonka.RDS.Types.ConnectionPoolConfigurationInfo

Methods

parseXML :: [Node] -> Either String ConnectionPoolConfigurationInfo

Generic ConnectionPoolConfigurationInfo

Defined in Amazonka.RDS.Types.ConnectionPoolConfigurationInfo

Associated Types

type Rep ConnectionPoolConfigurationInfo :: Type -> Type

Methods

from :: ConnectionPoolConfigurationInfo -> Rep ConnectionPoolConfigurationInfo x

to :: Rep ConnectionPoolConfigurationInfo x -> ConnectionPoolConfigurationInfo

Read ConnectionPoolConfigurationInfo

Defined in Amazonka.RDS.Types.ConnectionPoolConfigurationInfo

Methods

readsPrec :: Int -> ReadS ConnectionPoolConfigurationInfo

readList :: ReadS [ConnectionPoolConfigurationInfo]

readPrec :: ReadPrec ConnectionPoolConfigurationInfo

readListPrec :: ReadPrec [ConnectionPoolConfigurationInfo]

Show ConnectionPoolConfigurationInfo

Defined in Amazonka.RDS.Types.ConnectionPoolConfigurationInfo

Methods

showsPrec :: Int -> ConnectionPoolConfigurationInfo -> ShowS

show :: ConnectionPoolConfigurationInfo -> String

showList :: [ConnectionPoolConfigurationInfo] -> ShowS

NFData ConnectionPoolConfigurationInfo

Defined in Amazonka.RDS.Types.ConnectionPoolConfigurationInfo

Methods

rnf :: ConnectionPoolConfigurationInfo -> ()

Eq ConnectionPoolConfigurationInfo

Defined in Amazonka.RDS.Types.ConnectionPoolConfigurationInfo

Methods

(==) :: ConnectionPoolConfigurationInfo -> ConnectionPoolConfigurationInfo -> Bool

(/=) :: ConnectionPoolConfigurationInfo -> ConnectionPoolConfigurationInfo -> Bool

Hashable ConnectionPoolConfigurationInfo

Defined in Amazonka.RDS.Types.ConnectionPoolConfigurationInfo

Methods

hashWithSalt :: Int -> ConnectionPoolConfigurationInfo -> Int

hash :: ConnectionPoolConfigurationInfo -> Int

type Rep ConnectionPoolConfigurationInfo

Defined in Amazonka.RDS.Types.ConnectionPoolConfigurationInfo

type Rep ConnectionPoolConfigurationInfo = D1 ('MetaData "ConnectionPoolConfigurationInfo" "Amazonka.RDS.Types.ConnectionPoolConfigurationInfo" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "ConnectionPoolConfigurationInfo'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "connectionBorrowTimeout") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "initQuery") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "maxConnectionsPercent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: (S1 ('MetaSel ('Just "maxIdleConnectionsPercent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "sessionPinningFilters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))))))

newConnectionPoolConfigurationInfo :: ConnectionPoolConfigurationInfo

Create a value of ConnectionPoolConfigurationInfo 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:ConnectionPoolConfigurationInfo', connectionPoolConfigurationInfo_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.

$sel:initQuery:ConnectionPoolConfigurationInfo', connectionPoolConfigurationInfo_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. This setting is empty by default. 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.

$sel:maxConnectionsPercent:ConnectionPoolConfigurationInfo', connectionPoolConfigurationInfo_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.

$sel:maxIdleConnectionsPercent:ConnectionPoolConfigurationInfo', connectionPoolConfigurationInfo_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.

$sel:sessionPinningFilters:ConnectionPoolConfigurationInfo', connectionPoolConfigurationInfo_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. This setting is only supported for MySQL engine family databases. Currently, the only allowed value is EXCLUDE_VARIABLE_SETS.

connectionPoolConfigurationInfo_connectionBorrowTimeout :: Lens' ConnectionPoolConfigurationInfo (Maybe Int)

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.

connectionPoolConfigurationInfo_initQuery :: Lens' ConnectionPoolConfigurationInfo (Maybe Text)

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. This setting is empty by default. 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.

connectionPoolConfigurationInfo_maxConnectionsPercent :: Lens' ConnectionPoolConfigurationInfo (Maybe Int)

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.

connectionPoolConfigurationInfo_maxIdleConnectionsPercent :: Lens' ConnectionPoolConfigurationInfo (Maybe Int)

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.

connectionPoolConfigurationInfo_sessionPinningFilters :: Lens' ConnectionPoolConfigurationInfo (Maybe [Text])

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. This setting is only supported for MySQL engine family databases. Currently, the only allowed value is EXCLUDE_VARIABLE_SETS.