Struct ConnectionPoolConfigurationInfo 

#[non_exhaustive]
pub struct ConnectionPoolConfigurationInfo {
    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>,
}

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

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

max_idle_connections_percent: Option<i32>

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.

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.

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

init_query: Option<String>

One or more SQL statements for the proxy to run when opening each new database connection. The setting is typically used with SET statements to make sure that each connection has identical settings. The query added here must be valid. For including multiple variables in a single SET statement, use a comma separator. This is an optional field.

For example: SET variable1=value1, variable2=value2

Since you can access initialization query as part of target group configuration, it is not protected by authentication or cryptographic methods. Anyone with access to view or manage your proxy target group configuration can view the initialization query. You should not add sensitive data, such as passwords or long-lived encryption keys, to this option.

Implementations

impl ConnectionPoolConfigurationInfo

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

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.

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

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.

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.

pub fn session_pinning_filters(&self) -> &[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. This setting is only supported for MySQL engine family databases. Currently, the only allowed value is EXCLUDE_VARIABLE_SETS.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .session_pinning_filters.is_none().

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

One or more SQL statements for the proxy to run when opening each new database connection. The setting is typically used with SET statements to make sure that each connection has identical settings. The query added here must be valid. For including multiple variables in a single SET statement, use a comma separator. This is an optional field.

For example: SET variable1=value1, variable2=value2

Since you can access initialization query as part of target group configuration, it is not protected by authentication or cryptographic methods. Anyone with access to view or manage your proxy target group configuration can view the initialization query. You should not add sensitive data, such as passwords or long-lived encryption keys, to this option.

impl ConnectionPoolConfigurationInfo

pub fn builder() -> ConnectionPoolConfigurationInfoBuilder

Creates a new builder-style object to manufacture ConnectionPoolConfigurationInfo.

Trait Implementations

impl Clone for ConnectionPoolConfigurationInfo

fn clone(&self) -> ConnectionPoolConfigurationInfo

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ConnectionPoolConfigurationInfo

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

Formats the value using the given formatter.

impl PartialEq for ConnectionPoolConfigurationInfo

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ConnectionPoolConfigurationInfo