Struct aws_sdk_rds::model::ConnectionPoolConfiguration

#[non_exhaustive]
pub struct ConnectionPoolConfiguration {
    pub max_connections_percent: Option<i32>,
    pub max_idle_connections_percent: Option<i32>,
    pub connection_borrow_timeout: Option<i32>,
    pub session_pinning_filters: Option<Vec<String>>,
    pub init_query: Option<String>,
}

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

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

max_connections_percent: Option<i32>

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

max_idle_connections_percent: Option<i32>

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

connection_borrow_timeout: Option<i32>

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

session_pinning_filters: Option<Vec<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

init_query: Option<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

Implementations

impl ConnectionPoolConfiguration

pub fn max_connections_percent(&self) -> Option<i32>

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

pub fn max_idle_connections_percent(&self) -> Option<i32>

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

pub fn connection_borrow_timeout(&self) -> Option<i32>

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

pub fn session_pinning_filters(&self) -> Option<&[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

pub fn init_query(&self) -> Option<&str>

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

impl ConnectionPoolConfiguration

pub fn builder() -> Builder

Creates a new builder-style object to manufacture ConnectionPoolConfiguration

Trait Implementations

impl Clone for ConnectionPoolConfiguration

fn clone(&self) -> ConnectionPoolConfiguration

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ConnectionPoolConfiguration

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq<ConnectionPoolConfiguration> for ConnectionPoolConfiguration

fn eq(&self, other: &ConnectionPoolConfiguration) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &ConnectionPoolConfiguration) -> bool

This method tests for !=.

impl StructuralPartialEq for ConnectionPoolConfiguration