| 1 | |||
| 2 | package Paws::RDS::ModifyCurrentDBClusterCapacity; | ||
| 3 | use Moose; | ||
| 4 | has Capacity => (is => 'ro', isa => 'Int'); | ||
| 5 | has DBClusterIdentifier => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has SecondsBeforeTimeout => (is => 'ro', isa => 'Int'); | ||
| 7 | has TimeoutAction => (is => 'ro', isa => 'Str'); | ||
| 8 | |||
| 9 | use MooseX::ClassAttribute; | ||
| 10 | |||
| 11 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ModifyCurrentDBClusterCapacity'); | ||
| 12 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::RDS::DBClusterCapacityInfo'); | ||
| 13 | class_has _result_key => (isa => 'Str', is => 'ro', default => 'ModifyCurrentDBClusterCapacityResult'); | ||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::RDS::ModifyCurrentDBClusterCapacity - Arguments for method ModifyCurrentDBClusterCapacity on L<Paws::RDS> | ||
| 21 | |||
| 22 | =head1 DESCRIPTION | ||
| 23 | |||
| 24 | This class represents the parameters used for calling the method ModifyCurrentDBClusterCapacity on the | ||
| 25 | L<Amazon Relational Database Service|Paws::RDS> service. Use the attributes of this class | ||
| 26 | as arguments to method ModifyCurrentDBClusterCapacity. | ||
| 27 | |||
| 28 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ModifyCurrentDBClusterCapacity. | ||
| 29 | |||
| 30 | =head1 SYNOPSIS | ||
| 31 | |||
| 32 | my $rds = Paws->service('RDS'); | ||
| 33 | my $DBClusterCapacityInfo = $rds->ModifyCurrentDBClusterCapacity( | ||
| 34 | DBClusterIdentifier => 'MyString', | ||
| 35 | Capacity => 1, # OPTIONAL | ||
| 36 | SecondsBeforeTimeout => 1, # OPTIONAL | ||
| 37 | TimeoutAction => 'MyString', # OPTIONAL | ||
| 38 | ); | ||
| 39 | |||
| 40 | # Results: | ||
| 41 | my $CurrentCapacity = $DBClusterCapacityInfo->CurrentCapacity; | ||
| 42 | my $DBClusterIdentifier = $DBClusterCapacityInfo->DBClusterIdentifier; | ||
| 43 | my $PendingCapacity = $DBClusterCapacityInfo->PendingCapacity; | ||
| 44 | my $SecondsBeforeTimeout = $DBClusterCapacityInfo->SecondsBeforeTimeout; | ||
| 45 | my $TimeoutAction = $DBClusterCapacityInfo->TimeoutAction; | ||
| 46 | |||
| 47 | # Returns a L<Paws::RDS::DBClusterCapacityInfo> object. | ||
| 48 | |||
| 49 | Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. | ||
| 50 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/rds/ModifyCurrentDBClusterCapacity> | ||
| 51 | |||
| 52 | =head1 ATTRIBUTES | ||
| 53 | |||
| 54 | |||
| 55 | =head2 Capacity => Int | ||
| 56 | |||
| 57 | The DB cluster capacity. | ||
| 58 | |||
| 59 | When you change the capacity of a paused Aurora Serverless DB cluster, | ||
| 60 | it automatically resumes. | ||
| 61 | |||
| 62 | Constraints: | ||
| 63 | |||
| 64 | =over | ||
| 65 | |||
| 66 | =item * | ||
| 67 | |||
| 68 | For Aurora MySQL, valid capacity values are C<1>, C<2>, C<4>, C<8>, | ||
| 69 | C<16>, C<32>, C<64>, C<128>, and C<256>. | ||
| 70 | |||
| 71 | =item * | ||
| 72 | |||
| 73 | For Aurora PostgreSQL, valid capacity values are C<2>, C<4>, C<8>, | ||
| 74 | C<16>, C<32>, C<64>, C<192>, and C<384>. | ||
| 75 | |||
| 76 | =back | ||
| 77 | |||
| 78 | |||
| 79 | |||
| 80 | |||
| 81 | =head2 B<REQUIRED> DBClusterIdentifier => Str | ||
| 82 | |||
| 83 | The DB cluster identifier for the cluster being modified. This | ||
| 84 | parameter isn't case-sensitive. | ||
| 85 | |||
| 86 | Constraints: | ||
| 87 | |||
| 88 | =over | ||
| 89 | |||
| 90 | =item * | ||
| 91 | |||
| 92 | Must match the identifier of an existing DB cluster. | ||
| 93 | |||
| 94 | =back | ||
| 95 | |||
| 96 | |||
| 97 | |||
| 98 | |||
| 99 | =head2 SecondsBeforeTimeout => Int | ||
| 100 | |||
| 101 | The amount of time, in seconds, that Aurora Serverless tries to find a | ||
| 102 | scaling point to perform seamless scaling before enforcing the timeout | ||
| 103 | action. The default is 300. | ||
| 104 | |||
| 105 | =over | ||
| 106 | |||
| 107 | =item * | ||
| 108 | |||
| 109 | Value must be from 10 through 600. | ||
| 110 | |||
| 111 | =back | ||
| 112 | |||
| 113 | |||
| 114 | |||
| 115 | |||
| 116 | =head2 TimeoutAction => Str | ||
| 117 | |||
| 118 | The action to take when the timeout is reached, either | ||
| 119 | C<ForceApplyCapacityChange> or C<RollbackCapacityChange>. | ||
| 120 | |||
| 121 | C<ForceApplyCapacityChange>, the default, sets the capacity to the | ||
| 122 | specified value as soon as possible. | ||
| 123 | |||
| 124 | C<RollbackCapacityChange> ignores the capacity change if a scaling | ||
| 125 | point isn't found in the timeout period. | ||
| 126 | |||
| 127 | |||
| 128 | |||
| 129 | |||
| 130 | =head1 SEE ALSO | ||
| 131 | |||
| 132 | This class forms part of L<Paws>, documenting arguments for method ModifyCurrentDBClusterCapacity in L<Paws::RDS> | ||
| 133 | |||
| 134 | =head1 BUGS and CONTRIBUTIONS | ||
| 135 | |||
| 136 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 137 | |||
| 138 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 139 | |||
| 140 | =cut | ||
| 141 |