AWS SDK for C++  1.8.182
AWS SDK for C++
Public Member Functions | List of all members
Aws::RDS::Model::ConnectionPoolConfiguration Class Reference

#include <ConnectionPoolConfiguration.h>

Public Member Functions

 ConnectionPoolConfiguration ()
 
 ConnectionPoolConfiguration (const Aws::Utils::Xml::XmlNode &xmlNode)
 
ConnectionPoolConfigurationoperator= (const Aws::Utils::Xml::XmlNode &xmlNode)
 
void OutputToStream (Aws::OStream &ostream, const char *location, unsigned index, const char *locationValue) const
 
void OutputToStream (Aws::OStream &oStream, const char *location) const
 
int GetMaxConnectionsPercent () const
 
bool MaxConnectionsPercentHasBeenSet () const
 
void SetMaxConnectionsPercent (int value)
 
ConnectionPoolConfigurationWithMaxConnectionsPercent (int value)
 
int GetMaxIdleConnectionsPercent () const
 
bool MaxIdleConnectionsPercentHasBeenSet () const
 
void SetMaxIdleConnectionsPercent (int value)
 
ConnectionPoolConfigurationWithMaxIdleConnectionsPercent (int value)
 
int GetConnectionBorrowTimeout () const
 
bool ConnectionBorrowTimeoutHasBeenSet () const
 
void SetConnectionBorrowTimeout (int value)
 
ConnectionPoolConfigurationWithConnectionBorrowTimeout (int value)
 
const Aws::Vector< Aws::String > & GetSessionPinningFilters () const
 
bool SessionPinningFiltersHasBeenSet () const
 
void SetSessionPinningFilters (const Aws::Vector< Aws::String > &value)
 
void SetSessionPinningFilters (Aws::Vector< Aws::String > &&value)
 
ConnectionPoolConfigurationWithSessionPinningFilters (const Aws::Vector< Aws::String > &value)
 
ConnectionPoolConfigurationWithSessionPinningFilters (Aws::Vector< Aws::String > &&value)
 
ConnectionPoolConfigurationAddSessionPinningFilters (const Aws::String &value)
 
ConnectionPoolConfigurationAddSessionPinningFilters (Aws::String &&value)
 
ConnectionPoolConfigurationAddSessionPinningFilters (const char *value)
 
const Aws::StringGetInitQuery () const
 
bool InitQueryHasBeenSet () const
 
void SetInitQuery (const Aws::String &value)
 
void SetInitQuery (Aws::String &&value)
 
void SetInitQuery (const char *value)
 
ConnectionPoolConfigurationWithInitQuery (const Aws::String &value)
 
ConnectionPoolConfigurationWithInitQuery (Aws::String &&value)
 
ConnectionPoolConfigurationWithInitQuery (const char *value)
 

Detailed Description

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

See Also:

AWS API Reference

Definition at line 34 of file ConnectionPoolConfiguration.h.

Constructor & Destructor Documentation

◆ ConnectionPoolConfiguration() [1/2]

Aws::RDS::Model::ConnectionPoolConfiguration::ConnectionPoolConfiguration ( )

◆ ConnectionPoolConfiguration() [2/2]

Aws::RDS::Model::ConnectionPoolConfiguration::ConnectionPoolConfiguration ( const Aws::Utils::Xml::XmlNode xmlNode)

Member Function Documentation

◆ AddSessionPinningFilters() [1/3]

ConnectionPoolConfiguration& Aws::RDS::Model::ConnectionPoolConfiguration::AddSessionPinningFilters ( Aws::String &&  value)
inline

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

Definition at line 238 of file ConnectionPoolConfiguration.h.

◆ AddSessionPinningFilters() [2/3]

ConnectionPoolConfiguration& Aws::RDS::Model::ConnectionPoolConfiguration::AddSessionPinningFilters ( const Aws::String value)
inline

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

Definition at line 229 of file ConnectionPoolConfiguration.h.

◆ AddSessionPinningFilters() [3/3]

ConnectionPoolConfiguration& Aws::RDS::Model::ConnectionPoolConfiguration::AddSessionPinningFilters ( const char *  value)
inline

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

Definition at line 247 of file ConnectionPoolConfiguration.h.

◆ ConnectionBorrowTimeoutHasBeenSet()

bool Aws::RDS::Model::ConnectionPoolConfiguration::ConnectionBorrowTimeoutHasBeenSet ( ) const
inline

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

Definition at line 147 of file ConnectionPoolConfiguration.h.

◆ GetConnectionBorrowTimeout()

int Aws::RDS::Model::ConnectionPoolConfiguration::GetConnectionBorrowTimeout ( ) const
inline

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

Definition at line 138 of file ConnectionPoolConfiguration.h.

◆ GetInitQuery()

const Aws::String& Aws::RDS::Model::ConnectionPoolConfiguration::GetInitQuery ( ) const
inline

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

Definition at line 258 of file ConnectionPoolConfiguration.h.

◆ GetMaxConnectionsPercent()

int Aws::RDS::Model::ConnectionPoolConfiguration::GetMaxConnectionsPercent ( ) const
inline

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

Definition at line 52 of file ConnectionPoolConfiguration.h.

◆ GetMaxIdleConnectionsPercent()

int Aws::RDS::Model::ConnectionPoolConfiguration::GetMaxIdleConnectionsPercent ( ) const
inline

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

Definition at line 92 of file ConnectionPoolConfiguration.h.

◆ GetSessionPinningFilters()

const Aws::Vector<Aws::String>& Aws::RDS::Model::ConnectionPoolConfiguration::GetSessionPinningFilters ( ) const
inline

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

Definition at line 175 of file ConnectionPoolConfiguration.h.

◆ InitQueryHasBeenSet()

bool Aws::RDS::Model::ConnectionPoolConfiguration::InitQueryHasBeenSet ( ) const
inline

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

Definition at line 268 of file ConnectionPoolConfiguration.h.

◆ MaxConnectionsPercentHasBeenSet()

bool Aws::RDS::Model::ConnectionPoolConfiguration::MaxConnectionsPercentHasBeenSet ( ) const
inline

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

Definition at line 61 of file ConnectionPoolConfiguration.h.

◆ MaxIdleConnectionsPercentHasBeenSet()

bool Aws::RDS::Model::ConnectionPoolConfiguration::MaxIdleConnectionsPercentHasBeenSet ( ) const
inline

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

Definition at line 104 of file ConnectionPoolConfiguration.h.

◆ operator=()

ConnectionPoolConfiguration& Aws::RDS::Model::ConnectionPoolConfiguration::operator= ( const Aws::Utils::Xml::XmlNode xmlNode)

◆ OutputToStream() [1/2]

void Aws::RDS::Model::ConnectionPoolConfiguration::OutputToStream ( Aws::OStream oStream,
const char *  location 
) const

◆ OutputToStream() [2/2]

void Aws::RDS::Model::ConnectionPoolConfiguration::OutputToStream ( Aws::OStream ostream,
const char *  location,
unsigned  index,
const char *  locationValue 
) const

◆ SessionPinningFiltersHasBeenSet()

bool Aws::RDS::Model::ConnectionPoolConfiguration::SessionPinningFiltersHasBeenSet ( ) const
inline

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

Definition at line 184 of file ConnectionPoolConfiguration.h.

◆ SetConnectionBorrowTimeout()

void Aws::RDS::Model::ConnectionPoolConfiguration::SetConnectionBorrowTimeout ( int  value)
inline

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

Definition at line 156 of file ConnectionPoolConfiguration.h.

◆ SetInitQuery() [1/3]

void Aws::RDS::Model::ConnectionPoolConfiguration::SetInitQuery ( Aws::String &&  value)
inline

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

Definition at line 288 of file ConnectionPoolConfiguration.h.

◆ SetInitQuery() [2/3]

void Aws::RDS::Model::ConnectionPoolConfiguration::SetInitQuery ( const Aws::String value)
inline

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

Definition at line 278 of file ConnectionPoolConfiguration.h.

◆ SetInitQuery() [3/3]

void Aws::RDS::Model::ConnectionPoolConfiguration::SetInitQuery ( const char *  value)
inline

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

Definition at line 298 of file ConnectionPoolConfiguration.h.

◆ SetMaxConnectionsPercent()

void Aws::RDS::Model::ConnectionPoolConfiguration::SetMaxConnectionsPercent ( int  value)
inline

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

Definition at line 70 of file ConnectionPoolConfiguration.h.

◆ SetMaxIdleConnectionsPercent()

void Aws::RDS::Model::ConnectionPoolConfiguration::SetMaxIdleConnectionsPercent ( int  value)
inline

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

Definition at line 116 of file ConnectionPoolConfiguration.h.

◆ SetSessionPinningFilters() [1/2]

void Aws::RDS::Model::ConnectionPoolConfiguration::SetSessionPinningFilters ( Aws::Vector< Aws::String > &&  value)
inline

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

Definition at line 202 of file ConnectionPoolConfiguration.h.

◆ SetSessionPinningFilters() [2/2]

void Aws::RDS::Model::ConnectionPoolConfiguration::SetSessionPinningFilters ( const Aws::Vector< Aws::String > &  value)
inline

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

Definition at line 193 of file ConnectionPoolConfiguration.h.

◆ WithConnectionBorrowTimeout()

ConnectionPoolConfiguration& Aws::RDS::Model::ConnectionPoolConfiguration::WithConnectionBorrowTimeout ( int  value)
inline

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

Definition at line 165 of file ConnectionPoolConfiguration.h.

◆ WithInitQuery() [1/3]

ConnectionPoolConfiguration& Aws::RDS::Model::ConnectionPoolConfiguration::WithInitQuery ( Aws::String &&  value)
inline

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

Definition at line 318 of file ConnectionPoolConfiguration.h.

◆ WithInitQuery() [2/3]

ConnectionPoolConfiguration& Aws::RDS::Model::ConnectionPoolConfiguration::WithInitQuery ( const Aws::String value)
inline

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

Definition at line 308 of file ConnectionPoolConfiguration.h.

◆ WithInitQuery() [3/3]

ConnectionPoolConfiguration& Aws::RDS::Model::ConnectionPoolConfiguration::WithInitQuery ( const char *  value)
inline

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

Definition at line 328 of file ConnectionPoolConfiguration.h.

◆ WithMaxConnectionsPercent()

ConnectionPoolConfiguration& Aws::RDS::Model::ConnectionPoolConfiguration::WithMaxConnectionsPercent ( int  value)
inline

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

Definition at line 79 of file ConnectionPoolConfiguration.h.

◆ WithMaxIdleConnectionsPercent()

ConnectionPoolConfiguration& Aws::RDS::Model::ConnectionPoolConfiguration::WithMaxIdleConnectionsPercent ( int  value)
inline

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

Definition at line 128 of file ConnectionPoolConfiguration.h.

◆ WithSessionPinningFilters() [1/2]

ConnectionPoolConfiguration& Aws::RDS::Model::ConnectionPoolConfiguration::WithSessionPinningFilters ( Aws::Vector< Aws::String > &&  value)
inline

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

Definition at line 220 of file ConnectionPoolConfiguration.h.

◆ WithSessionPinningFilters() [2/2]

ConnectionPoolConfiguration& Aws::RDS::Model::ConnectionPoolConfiguration::WithSessionPinningFilters ( const Aws::Vector< Aws::String > &  value)
inline

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

Definition at line 211 of file ConnectionPoolConfiguration.h.


The documentation for this class was generated from the following file: