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

#include <ConnectionPoolConfigurationInfo.h>

Public Member Functions

 ConnectionPoolConfigurationInfo ()
 
 ConnectionPoolConfigurationInfo (const Aws::Utils::Xml::XmlNode &xmlNode)
 
ConnectionPoolConfigurationInfooperator= (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)
 
ConnectionPoolConfigurationInfoWithMaxConnectionsPercent (int value)
 
int GetMaxIdleConnectionsPercent () const
 
bool MaxIdleConnectionsPercentHasBeenSet () const
 
void SetMaxIdleConnectionsPercent (int value)
 
ConnectionPoolConfigurationInfoWithMaxIdleConnectionsPercent (int value)
 
int GetConnectionBorrowTimeout () const
 
bool ConnectionBorrowTimeoutHasBeenSet () const
 
void SetConnectionBorrowTimeout (int value)
 
ConnectionPoolConfigurationInfoWithConnectionBorrowTimeout (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)
 
ConnectionPoolConfigurationInfoWithSessionPinningFilters (const Aws::Vector< Aws::String > &value)
 
ConnectionPoolConfigurationInfoWithSessionPinningFilters (Aws::Vector< Aws::String > &&value)
 
ConnectionPoolConfigurationInfoAddSessionPinningFilters (const Aws::String &value)
 
ConnectionPoolConfigurationInfoAddSessionPinningFilters (Aws::String &&value)
 
ConnectionPoolConfigurationInfoAddSessionPinningFilters (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)
 
ConnectionPoolConfigurationInfoWithInitQuery (const Aws::String &value)
 
ConnectionPoolConfigurationInfoWithInitQuery (Aws::String &&value)
 
ConnectionPoolConfigurationInfoWithInitQuery (const char *value)
 

Detailed Description

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

See Also:

AWS API Reference

Definition at line 33 of file ConnectionPoolConfigurationInfo.h.

Constructor & Destructor Documentation

◆ ConnectionPoolConfigurationInfo() [1/2]

Aws::RDS::Model::ConnectionPoolConfigurationInfo::ConnectionPoolConfigurationInfo ( )

◆ ConnectionPoolConfigurationInfo() [2/2]

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

Member Function Documentation

◆ AddSessionPinningFilters() [1/3]

ConnectionPoolConfigurationInfo& Aws::RDS::Model::ConnectionPoolConfigurationInfo::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. Currently, the only allowed value is EXCLUDE_VARIABLE_SETS.

Definition at line 225 of file ConnectionPoolConfigurationInfo.h.

◆ AddSessionPinningFilters() [2/3]

ConnectionPoolConfigurationInfo& Aws::RDS::Model::ConnectionPoolConfigurationInfo::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. Currently, the only allowed value is EXCLUDE_VARIABLE_SETS.

Definition at line 216 of file ConnectionPoolConfigurationInfo.h.

◆ AddSessionPinningFilters() [3/3]

ConnectionPoolConfigurationInfo& Aws::RDS::Model::ConnectionPoolConfigurationInfo::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. Currently, the only allowed value is EXCLUDE_VARIABLE_SETS.

Definition at line 234 of file ConnectionPoolConfigurationInfo.h.

◆ ConnectionBorrowTimeoutHasBeenSet()

bool Aws::RDS::Model::ConnectionPoolConfigurationInfo::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.

Definition at line 136 of file ConnectionPoolConfigurationInfo.h.

◆ GetConnectionBorrowTimeout()

int Aws::RDS::Model::ConnectionPoolConfigurationInfo::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.

Definition at line 128 of file ConnectionPoolConfigurationInfo.h.

◆ GetInitQuery()

const Aws::String& Aws::RDS::Model::ConnectionPoolConfigurationInfo::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. 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.

Definition at line 245 of file ConnectionPoolConfigurationInfo.h.

◆ GetMaxConnectionsPercent()

int Aws::RDS::Model::ConnectionPoolConfigurationInfo::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.

Definition at line 50 of file ConnectionPoolConfigurationInfo.h.

◆ GetMaxIdleConnectionsPercent()

int Aws::RDS::Model::ConnectionPoolConfigurationInfo::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.

Definition at line 86 of file ConnectionPoolConfigurationInfo.h.

◆ GetSessionPinningFilters()

const Aws::Vector<Aws::String>& Aws::RDS::Model::ConnectionPoolConfigurationInfo::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. Currently, the only allowed value is EXCLUDE_VARIABLE_SETS.

Definition at line 162 of file ConnectionPoolConfigurationInfo.h.

◆ InitQueryHasBeenSet()

bool Aws::RDS::Model::ConnectionPoolConfigurationInfo::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. 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.

Definition at line 255 of file ConnectionPoolConfigurationInfo.h.

◆ MaxConnectionsPercentHasBeenSet()

bool Aws::RDS::Model::ConnectionPoolConfigurationInfo::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.

Definition at line 58 of file ConnectionPoolConfigurationInfo.h.

◆ MaxIdleConnectionsPercentHasBeenSet()

bool Aws::RDS::Model::ConnectionPoolConfigurationInfo::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.

Definition at line 97 of file ConnectionPoolConfigurationInfo.h.

◆ operator=()

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

◆ OutputToStream() [1/2]

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

◆ OutputToStream() [2/2]

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

◆ SessionPinningFiltersHasBeenSet()

bool Aws::RDS::Model::ConnectionPoolConfigurationInfo::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. Currently, the only allowed value is EXCLUDE_VARIABLE_SETS.

Definition at line 171 of file ConnectionPoolConfigurationInfo.h.

◆ SetConnectionBorrowTimeout()

void Aws::RDS::Model::ConnectionPoolConfigurationInfo::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.

Definition at line 144 of file ConnectionPoolConfigurationInfo.h.

◆ SetInitQuery() [1/3]

void Aws::RDS::Model::ConnectionPoolConfigurationInfo::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. 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.

Definition at line 275 of file ConnectionPoolConfigurationInfo.h.

◆ SetInitQuery() [2/3]

void Aws::RDS::Model::ConnectionPoolConfigurationInfo::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. 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.

Definition at line 265 of file ConnectionPoolConfigurationInfo.h.

◆ SetInitQuery() [3/3]

void Aws::RDS::Model::ConnectionPoolConfigurationInfo::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. 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.

Definition at line 285 of file ConnectionPoolConfigurationInfo.h.

◆ SetMaxConnectionsPercent()

void Aws::RDS::Model::ConnectionPoolConfigurationInfo::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.

Definition at line 66 of file ConnectionPoolConfigurationInfo.h.

◆ SetMaxIdleConnectionsPercent()

void Aws::RDS::Model::ConnectionPoolConfigurationInfo::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.

Definition at line 108 of file ConnectionPoolConfigurationInfo.h.

◆ SetSessionPinningFilters() [1/2]

void Aws::RDS::Model::ConnectionPoolConfigurationInfo::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. Currently, the only allowed value is EXCLUDE_VARIABLE_SETS.

Definition at line 189 of file ConnectionPoolConfigurationInfo.h.

◆ SetSessionPinningFilters() [2/2]

void Aws::RDS::Model::ConnectionPoolConfigurationInfo::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. Currently, the only allowed value is EXCLUDE_VARIABLE_SETS.

Definition at line 180 of file ConnectionPoolConfigurationInfo.h.

◆ WithConnectionBorrowTimeout()

ConnectionPoolConfigurationInfo& Aws::RDS::Model::ConnectionPoolConfigurationInfo::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.

Definition at line 152 of file ConnectionPoolConfigurationInfo.h.

◆ WithInitQuery() [1/3]

ConnectionPoolConfigurationInfo& Aws::RDS::Model::ConnectionPoolConfigurationInfo::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. 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.

Definition at line 305 of file ConnectionPoolConfigurationInfo.h.

◆ WithInitQuery() [2/3]

ConnectionPoolConfigurationInfo& Aws::RDS::Model::ConnectionPoolConfigurationInfo::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. 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.

Definition at line 295 of file ConnectionPoolConfigurationInfo.h.

◆ WithInitQuery() [3/3]

ConnectionPoolConfigurationInfo& Aws::RDS::Model::ConnectionPoolConfigurationInfo::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. 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.

Definition at line 315 of file ConnectionPoolConfigurationInfo.h.

◆ WithMaxConnectionsPercent()

ConnectionPoolConfigurationInfo& Aws::RDS::Model::ConnectionPoolConfigurationInfo::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.

Definition at line 74 of file ConnectionPoolConfigurationInfo.h.

◆ WithMaxIdleConnectionsPercent()

ConnectionPoolConfigurationInfo& Aws::RDS::Model::ConnectionPoolConfigurationInfo::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.

Definition at line 119 of file ConnectionPoolConfigurationInfo.h.

◆ WithSessionPinningFilters() [1/2]

ConnectionPoolConfigurationInfo& Aws::RDS::Model::ConnectionPoolConfigurationInfo::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. Currently, the only allowed value is EXCLUDE_VARIABLE_SETS.

Definition at line 207 of file ConnectionPoolConfigurationInfo.h.

◆ WithSessionPinningFilters() [2/2]

ConnectionPoolConfigurationInfo& Aws::RDS::Model::ConnectionPoolConfigurationInfo::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. Currently, the only allowed value is EXCLUDE_VARIABLE_SETS.

Definition at line 198 of file ConnectionPoolConfigurationInfo.h.


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