« blib/lib/Paws/RDS/ClusterPendingModifiedValues.pm
↑ Summary
blib/lib/Paws/RDS/ConnectionPoolConfigurationInfo.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::RDS::ConnectionPoolConfiguration; | ||
| 3 | use Moose; | ||
| 4 | has ConnectionBorrowTimeout => (is => 'ro', isa => 'Int'); | ||
| 5 | has InitQuery => (is => 'ro', isa => 'Str'); | ||
| 6 | has MaxConnectionsPercent => (is => 'ro', isa => 'Int'); | ||
| 7 | has MaxIdleConnectionsPercent => (is => 'ro', isa => 'Int'); | ||
| 8 | has SessionPinningFilters => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 9 | |||
| 10 | 1; | ||
| 11 | |||
| 12 | ### main pod documentation begin ### | ||
| 13 | |||
| 14 | =head1 NAME | ||
| 15 | |||
| 16 | Paws::RDS::ConnectionPoolConfiguration | ||
| 17 | |||
| 18 | =head1 USAGE | ||
| 19 | |||
| 20 | This class represents one of two things: | ||
| 21 | |||
| 22 | =head3 Arguments in a call to a service | ||
| 23 | |||
| 24 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 25 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 26 | |||
| 27 | As an example, if Att1 is expected to be a Paws::RDS::ConnectionPoolConfiguration object: | ||
| 28 | |||
| 29 | $service_obj->Method(Att1 => { ConnectionBorrowTimeout => $value, ..., SessionPinningFilters => $value }); | ||
| 30 | |||
| 31 | =head3 Results returned from an API call | ||
| 32 | |||
| 33 | Use accessors for each attribute. If Att1 is expected to be an Paws::RDS::ConnectionPoolConfiguration object: | ||
| 34 | |||
| 35 | $result = $service_obj->Method(...); | ||
| 36 | $result->Att1->ConnectionBorrowTimeout | ||
| 37 | |||
| 38 | =head1 DESCRIPTION | ||
| 39 | |||
| 40 | Specifies the settings that control the size and behavior of the | ||
| 41 | connection pool associated with a C<DBProxyTargetGroup>. | ||
| 42 | |||
| 43 | =head1 ATTRIBUTES | ||
| 44 | |||
| 45 | |||
| 46 | =head2 ConnectionBorrowTimeout => Int | ||
| 47 | |||
| 48 | The number of seconds for a proxy to wait for a connection to become | ||
| 49 | available in the connection pool. Only applies when the proxy has | ||
| 50 | opened its maximum number of connections and all connections are busy | ||
| 51 | with client sessions. | ||
| 52 | |||
| 53 | Default: 120 | ||
| 54 | |||
| 55 | Constraints: between 1 and 3600, or 0 representing unlimited | ||
| 56 | |||
| 57 | |||
| 58 | =head2 InitQuery => Str | ||
| 59 | |||
| 60 | One or more SQL statements for the proxy to run when opening each new | ||
| 61 | database connection. Typically used with C<SET> statements to make sure | ||
| 62 | that each connection has identical settings such as time zone and | ||
| 63 | character set. For multiple statements, use semicolons as the | ||
| 64 | separator. You can also include multiple variables in a single C<SET> | ||
| 65 | statement, such as C<SET x=1, y=2>. | ||
| 66 | |||
| 67 | Default: no initialization query | ||
| 68 | |||
| 69 | |||
| 70 | =head2 MaxConnectionsPercent => Int | ||
| 71 | |||
| 72 | The maximum size of the connection pool for each target in a target | ||
| 73 | group. For Aurora MySQL, it is expressed as a percentage of the | ||
| 74 | C<max_connections> setting for the RDS DB instance or Aurora DB cluster | ||
| 75 | used by the target group. | ||
| 76 | |||
| 77 | Default: 100 | ||
| 78 | |||
| 79 | Constraints: between 1 and 100 | ||
| 80 | |||
| 81 | |||
| 82 | =head2 MaxIdleConnectionsPercent => Int | ||
| 83 | |||
| 84 | Controls how actively the proxy closes idle database connections in the | ||
| 85 | connection pool. A high value enables the proxy to leave a high | ||
| 86 | percentage of idle connections open. A low value causes the proxy to | ||
| 87 | close idle client connections and return the underlying database | ||
| 88 | connections to the connection pool. For Aurora MySQL, it is expressed | ||
| 89 | as a percentage of the C<max_connections> setting for the RDS DB | ||
| 90 | instance or Aurora DB cluster used by the target group. | ||
| 91 | |||
| 92 | Default: 50 | ||
| 93 | |||
| 94 | Constraints: between 0 and C<MaxConnectionsPercent> | ||
| 95 | |||
| 96 | |||
| 97 | =head2 SessionPinningFilters => ArrayRef[Str|Undef] | ||
| 98 | |||
| 99 | Each item in the list represents a class of SQL operations that | ||
| 100 | normally cause all later statements in a session using a proxy to be | ||
| 101 | pinned to the same underlying database connection. Including an item in | ||
| 102 | the list exempts that class of SQL operations from the pinning | ||
| 103 | behavior. | ||
| 104 | |||
| 105 | Default: no session pinning filters | ||
| 106 | |||
| 107 | |||
| 108 | |||
| 109 | =head1 SEE ALSO | ||
| 110 | |||
| 111 | This class forms part of L<Paws>, describing an object used in L<Paws::RDS> | ||
| 112 | |||
| 113 | =head1 BUGS and CONTRIBUTIONS | ||
| 114 | |||
| 115 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 116 | |||
| 117 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 118 | |||
| 119 | =cut | ||
| 120 |