« blib/lib/Paws/RDS/RevokeDBSecurityGroupIngressResult.pm
↑ Summary
blib/lib/Paws/RDS/ScalingConfigurationInfo.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::RDS::ScalingConfiguration; | ||
| 3 | use Moose; | ||
| 4 | has AutoPause => (is => 'ro', isa => 'Bool'); | ||
| 5 | has MaxCapacity => (is => 'ro', isa => 'Int'); | ||
| 6 | has MinCapacity => (is => 'ro', isa => 'Int'); | ||
| 7 | has SecondsUntilAutoPause => (is => 'ro', isa => 'Int'); | ||
| 8 | has TimeoutAction => (is => 'ro', isa => 'Str'); | ||
| 9 | |||
| 10 | 1; | ||
| 11 | |||
| 12 | ### main pod documentation begin ### | ||
| 13 | |||
| 14 | =head1 NAME | ||
| 15 | |||
| 16 | Paws::RDS::ScalingConfiguration | ||
| 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::ScalingConfiguration object: | ||
| 28 | |||
| 29 | $service_obj->Method(Att1 => { AutoPause => $value, ..., TimeoutAction => $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::ScalingConfiguration object: | ||
| 34 | |||
| 35 | $result = $service_obj->Method(...); | ||
| 36 | $result->Att1->AutoPause | ||
| 37 | |||
| 38 | =head1 DESCRIPTION | ||
| 39 | |||
| 40 | Contains the scaling configuration of an Aurora Serverless DB cluster. | ||
| 41 | |||
| 42 | For more information, see Using Amazon Aurora Serverless | ||
| 43 | (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html) | ||
| 44 | in the I<Amazon Aurora User Guide>. | ||
| 45 | |||
| 46 | =head1 ATTRIBUTES | ||
| 47 | |||
| 48 | |||
| 49 | =head2 AutoPause => Bool | ||
| 50 | |||
| 51 | A value that indicates whether to allow or disallow automatic pause for | ||
| 52 | an Aurora DB cluster in C<serverless> DB engine mode. A DB cluster can | ||
| 53 | be paused only when it's idle (it has no connections). | ||
| 54 | |||
| 55 | If a DB cluster is paused for more than seven days, the DB cluster | ||
| 56 | might be backed up with a snapshot. In this case, the DB cluster is | ||
| 57 | restored when there is a request to connect to it. | ||
| 58 | |||
| 59 | |||
| 60 | =head2 MaxCapacity => Int | ||
| 61 | |||
| 62 | The maximum capacity for an Aurora DB cluster in C<serverless> DB | ||
| 63 | engine mode. | ||
| 64 | |||
| 65 | For Aurora MySQL, valid capacity values are C<1>, C<2>, C<4>, C<8>, | ||
| 66 | C<16>, C<32>, C<64>, C<128>, and C<256>. | ||
| 67 | |||
| 68 | For Aurora PostgreSQL, valid capacity values are C<2>, C<4>, C<8>, | ||
| 69 | C<16>, C<32>, C<64>, C<192>, and C<384>. | ||
| 70 | |||
| 71 | The maximum capacity must be greater than or equal to the minimum | ||
| 72 | capacity. | ||
| 73 | |||
| 74 | |||
| 75 | =head2 MinCapacity => Int | ||
| 76 | |||
| 77 | The minimum capacity for an Aurora DB cluster in C<serverless> DB | ||
| 78 | engine mode. | ||
| 79 | |||
| 80 | For Aurora MySQL, valid capacity values are C<1>, C<2>, C<4>, C<8>, | ||
| 81 | C<16>, C<32>, C<64>, C<128>, and C<256>. | ||
| 82 | |||
| 83 | For Aurora PostgreSQL, valid capacity values are C<2>, C<4>, C<8>, | ||
| 84 | C<16>, C<32>, C<64>, C<192>, and C<384>. | ||
| 85 | |||
| 86 | The minimum capacity must be less than or equal to the maximum | ||
| 87 | capacity. | ||
| 88 | |||
| 89 | |||
| 90 | =head2 SecondsUntilAutoPause => Int | ||
| 91 | |||
| 92 | The time, in seconds, before an Aurora DB cluster in C<serverless> mode | ||
| 93 | is paused. | ||
| 94 | |||
| 95 | Specify a value between 300 and 86,400 seconds. | ||
| 96 | |||
| 97 | |||
| 98 | =head2 TimeoutAction => Str | ||
| 99 | |||
| 100 | The action to take when the timeout is reached, either | ||
| 101 | C<ForceApplyCapacityChange> or C<RollbackCapacityChange>. | ||
| 102 | |||
| 103 | C<ForceApplyCapacityChange> sets the capacity to the specified value as | ||
| 104 | soon as possible. | ||
| 105 | |||
| 106 | C<RollbackCapacityChange>, the default, ignores the capacity change if | ||
| 107 | a scaling point isn't found in the timeout period. | ||
| 108 | |||
| 109 | If you specify C<ForceApplyCapacityChange>, connections that prevent | ||
| 110 | Aurora Serverless from finding a scaling point might be dropped. | ||
| 111 | |||
| 112 | For more information, see Autoscaling for Aurora Serverless | ||
| 113 | (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.how-it-works.html#aurora-serverless.how-it-works.auto-scaling) | ||
| 114 | in the I<Amazon Aurora User Guide>. | ||
| 115 | |||
| 116 | |||
| 117 | |||
| 118 | =head1 SEE ALSO | ||
| 119 | |||
| 120 | This class forms part of L<Paws>, describing an object used in L<Paws::RDS> | ||
| 121 | |||
| 122 | =head1 BUGS and CONTRIBUTIONS | ||
| 123 | |||
| 124 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 125 | |||
| 126 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 127 | |||
| 128 | =cut | ||
| 129 |