« blib/lib/Paws/AutoScaling/RecordLifecycleActionHeartbeatAnswer.pm
↑ Summary
blib/lib/Paws/AutoScaling/ResumeProcesses.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::AutoScaling::RefreshPreferences; | ||
| 3 | use Moose; | ||
| 4 | has CheckpointDelay => (is => 'ro', isa => 'Int'); | ||
| 5 | has CheckpointPercentages => (is => 'ro', isa => 'ArrayRef[Int]'); | ||
| 6 | has InstanceWarmup => (is => 'ro', isa => 'Int'); | ||
| 7 | has MinHealthyPercentage => (is => 'ro', isa => 'Int'); | ||
| 8 | |||
| 9 | 1; | ||
| 10 | |||
| 11 | ### main pod documentation begin ### | ||
| 12 | |||
| 13 | =head1 NAME | ||
| 14 | |||
| 15 | Paws::AutoScaling::RefreshPreferences | ||
| 16 | |||
| 17 | =head1 USAGE | ||
| 18 | |||
| 19 | This class represents one of two things: | ||
| 20 | |||
| 21 | =head3 Arguments in a call to a service | ||
| 22 | |||
| 23 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 24 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 25 | |||
| 26 | As an example, if Att1 is expected to be a Paws::AutoScaling::RefreshPreferences object: | ||
| 27 | |||
| 28 | $service_obj->Method(Att1 => { CheckpointDelay => $value, ..., MinHealthyPercentage => $value }); | ||
| 29 | |||
| 30 | =head3 Results returned from an API call | ||
| 31 | |||
| 32 | Use accessors for each attribute. If Att1 is expected to be an Paws::AutoScaling::RefreshPreferences object: | ||
| 33 | |||
| 34 | $result = $service_obj->Method(...); | ||
| 35 | $result->Att1->CheckpointDelay | ||
| 36 | |||
| 37 | =head1 DESCRIPTION | ||
| 38 | |||
| 39 | Describes information used to start an instance refresh. | ||
| 40 | |||
| 41 | All properties are optional. However, if you specify a value for | ||
| 42 | C<CheckpointDelay>, you must also provide a value for | ||
| 43 | C<CheckpointPercentages>. | ||
| 44 | |||
| 45 | =head1 ATTRIBUTES | ||
| 46 | |||
| 47 | |||
| 48 | =head2 CheckpointDelay => Int | ||
| 49 | |||
| 50 | The amount of time, in seconds, to wait after a checkpoint before | ||
| 51 | continuing. This property is optional, but if you specify a value for | ||
| 52 | it, you must also specify a value for C<CheckpointPercentages>. If you | ||
| 53 | specify a value for C<CheckpointPercentages> and not for | ||
| 54 | C<CheckpointDelay>, the C<CheckpointDelay> defaults to C<3600> (1 | ||
| 55 | hour). | ||
| 56 | |||
| 57 | |||
| 58 | =head2 CheckpointPercentages => ArrayRef[Int] | ||
| 59 | |||
| 60 | Threshold values for each checkpoint in ascending order. Each number | ||
| 61 | must be unique. To replace all instances in the Auto Scaling group, the | ||
| 62 | last number in the array must be C<100>. | ||
| 63 | |||
| 64 | For usage examples, see Adding checkpoints to an instance refresh | ||
| 65 | (https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-adding-checkpoints-instance-refresh.html) | ||
| 66 | in the I<Amazon EC2 Auto Scaling User Guide>. | ||
| 67 | |||
| 68 | |||
| 69 | =head2 InstanceWarmup => Int | ||
| 70 | |||
| 71 | The number of seconds until a newly launched instance is configured and | ||
| 72 | ready to use. During this time, Amazon EC2 Auto Scaling does not | ||
| 73 | immediately move on to the next replacement. The default is to use the | ||
| 74 | value for the health check grace period defined for the group. | ||
| 75 | |||
| 76 | |||
| 77 | =head2 MinHealthyPercentage => Int | ||
| 78 | |||
| 79 | The amount of capacity in the Auto Scaling group that must remain | ||
| 80 | healthy during an instance refresh to allow the operation to continue, | ||
| 81 | as a percentage of the desired capacity of the Auto Scaling group | ||
| 82 | (rounded up to the nearest integer). The default is C<90>. | ||
| 83 | |||
| 84 | |||
| 85 | |||
| 86 | =head1 SEE ALSO | ||
| 87 | |||
| 88 | This class forms part of L<Paws>, describing an object used in L<Paws::AutoScaling> | ||
| 89 | |||
| 90 | =head1 BUGS and CONTRIBUTIONS | ||
| 91 | |||
| 92 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 93 | |||
| 94 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 95 | |||
| 96 | =cut | ||
| 97 |