« blib/lib/Paws/AutoScaling/PutScheduledUpdateGroupAction.pm
↑ Summary
blib/lib/Paws/AutoScaling/PutWarmPoolAnswer.pm »
| 1 | |||
| 2 | package Paws::AutoScaling::PutWarmPool; | ||
| 3 | use Moose; | ||
| 4 | has AutoScalingGroupName => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has MaxGroupPreparedCapacity => (is => 'ro', isa => 'Int'); | ||
| 6 | has MinSize => (is => 'ro', isa => 'Int'); | ||
| 7 | has PoolState => (is => 'ro', isa => 'Str'); | ||
| 8 | |||
| 9 | use MooseX::ClassAttribute; | ||
| 10 | |||
| 11 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'PutWarmPool'); | ||
| 12 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::AutoScaling::PutWarmPoolAnswer'); | ||
| 13 | class_has _result_key => (isa => 'Str', is => 'ro', default => 'PutWarmPoolResult'); | ||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::AutoScaling::PutWarmPool - Arguments for method PutWarmPool on L<Paws::AutoScaling> | ||
| 21 | |||
| 22 | =head1 DESCRIPTION | ||
| 23 | |||
| 24 | This class represents the parameters used for calling the method PutWarmPool on the | ||
| 25 | L<Auto Scaling|Paws::AutoScaling> service. Use the attributes of this class | ||
| 26 | as arguments to method PutWarmPool. | ||
| 27 | |||
| 28 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to PutWarmPool. | ||
| 29 | |||
| 30 | =head1 SYNOPSIS | ||
| 31 | |||
| 32 | my $autoscaling = Paws->service('AutoScaling'); | ||
| 33 | # To add a warm pool to an Auto Scaling group | ||
| 34 | # This example adds a warm pool to the specified Auto Scaling group. | ||
| 35 | my $PutWarmPoolAnswer = $autoscaling->PutWarmPool( | ||
| 36 | 'AutoScalingGroupName' => 'my-auto-scaling-group', | ||
| 37 | 'MinSize' => 30, | ||
| 38 | 'PoolState' => 'Stopped' | ||
| 39 | ); | ||
| 40 | |||
| 41 | |||
| 42 | 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. | ||
| 43 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/autoscaling/PutWarmPool> | ||
| 44 | |||
| 45 | =head1 ATTRIBUTES | ||
| 46 | |||
| 47 | |||
| 48 | =head2 B<REQUIRED> AutoScalingGroupName => Str | ||
| 49 | |||
| 50 | The name of the Auto Scaling group. | ||
| 51 | |||
| 52 | |||
| 53 | |||
| 54 | =head2 MaxGroupPreparedCapacity => Int | ||
| 55 | |||
| 56 | Specifies the maximum number of instances that are allowed to be in the | ||
| 57 | warm pool or in any state except C<Terminated> for the Auto Scaling | ||
| 58 | group. This is an optional property. Specify it only if you do not want | ||
| 59 | the warm pool size to be determined by the difference between the | ||
| 60 | group's maximum capacity and its desired capacity. | ||
| 61 | |||
| 62 | If a value for C<MaxGroupPreparedCapacity> is not specified, Amazon EC2 | ||
| 63 | Auto Scaling launches and maintains the difference between the group's | ||
| 64 | maximum capacity and its desired capacity. If you specify a value for | ||
| 65 | C<MaxGroupPreparedCapacity>, Amazon EC2 Auto Scaling uses the | ||
| 66 | difference between the C<MaxGroupPreparedCapacity> and the desired | ||
| 67 | capacity instead. | ||
| 68 | |||
| 69 | The size of the warm pool is dynamic. Only when | ||
| 70 | C<MaxGroupPreparedCapacity> and C<MinSize> are set to the same value | ||
| 71 | does the warm pool have an absolute size. | ||
| 72 | |||
| 73 | If the desired capacity of the Auto Scaling group is higher than the | ||
| 74 | C<MaxGroupPreparedCapacity>, the capacity of the warm pool is 0, unless | ||
| 75 | you specify a value for C<MinSize>. To remove a value that you | ||
| 76 | previously set, include the property but specify -1 for the value. | ||
| 77 | |||
| 78 | |||
| 79 | |||
| 80 | =head2 MinSize => Int | ||
| 81 | |||
| 82 | Specifies the minimum number of instances to maintain in the warm pool. | ||
| 83 | This helps you to ensure that there is always a certain number of | ||
| 84 | warmed instances available to handle traffic spikes. Defaults to 0 if | ||
| 85 | not specified. | ||
| 86 | |||
| 87 | |||
| 88 | |||
| 89 | =head2 PoolState => Str | ||
| 90 | |||
| 91 | Sets the instance state to transition to after the lifecycle actions | ||
| 92 | are complete. Default is C<Stopped>. | ||
| 93 | |||
| 94 | Valid values are: C<"Stopped">, C<"Running"> | ||
| 95 | |||
| 96 | |||
| 97 | =head1 SEE ALSO | ||
| 98 | |||
| 99 | This class forms part of L<Paws>, documenting arguments for method PutWarmPool in L<Paws::AutoScaling> | ||
| 100 | |||
| 101 | =head1 BUGS and CONTRIBUTIONS | ||
| 102 | |||
| 103 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 104 | |||
| 105 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 106 | |||
| 107 | =cut | ||
| 108 |