« blib/lib/Paws/AutoScaling/InstanceMonitoring.pm
↑ Summary
blib/lib/Paws/AutoScaling/InstanceRefreshLivePoolProgress.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::AutoScaling::InstanceRefresh; | ||
| 3 | use Moose; | ||
| 4 | has AutoScalingGroupName => (is => 'ro', isa => 'Str'); | ||
| 5 | has EndTime => (is => 'ro', isa => 'Str'); | ||
| 6 | has InstanceRefreshId => (is => 'ro', isa => 'Str'); | ||
| 7 | has InstancesToUpdate => (is => 'ro', isa => 'Int'); | ||
| 8 | has PercentageComplete => (is => 'ro', isa => 'Int'); | ||
| 9 | has ProgressDetails => (is => 'ro', isa => 'Paws::AutoScaling::InstanceRefreshProgressDetails'); | ||
| 10 | has StartTime => (is => 'ro', isa => 'Str'); | ||
| 11 | has Status => (is => 'ro', isa => 'Str'); | ||
| 12 | has StatusReason => (is => 'ro', isa => 'Str'); | ||
| 13 | |||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::AutoScaling::InstanceRefresh | ||
| 21 | |||
| 22 | =head1 USAGE | ||
| 23 | |||
| 24 | This class represents one of two things: | ||
| 25 | |||
| 26 | =head3 Arguments in a call to a service | ||
| 27 | |||
| 28 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 29 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 30 | |||
| 31 | As an example, if Att1 is expected to be a Paws::AutoScaling::InstanceRefresh object: | ||
| 32 | |||
| 33 | $service_obj->Method(Att1 => { AutoScalingGroupName => $value, ..., StatusReason => $value }); | ||
| 34 | |||
| 35 | =head3 Results returned from an API call | ||
| 36 | |||
| 37 | Use accessors for each attribute. If Att1 is expected to be an Paws::AutoScaling::InstanceRefresh object: | ||
| 38 | |||
| 39 | $result = $service_obj->Method(...); | ||
| 40 | $result->Att1->AutoScalingGroupName | ||
| 41 | |||
| 42 | =head1 DESCRIPTION | ||
| 43 | |||
| 44 | Describes an instance refresh for an Auto Scaling group. | ||
| 45 | |||
| 46 | =head1 ATTRIBUTES | ||
| 47 | |||
| 48 | |||
| 49 | =head2 AutoScalingGroupName => Str | ||
| 50 | |||
| 51 | The name of the Auto Scaling group. | ||
| 52 | |||
| 53 | |||
| 54 | =head2 EndTime => Str | ||
| 55 | |||
| 56 | The date and time at which the instance refresh ended. | ||
| 57 | |||
| 58 | |||
| 59 | =head2 InstanceRefreshId => Str | ||
| 60 | |||
| 61 | The instance refresh ID. | ||
| 62 | |||
| 63 | |||
| 64 | =head2 InstancesToUpdate => Int | ||
| 65 | |||
| 66 | The number of instances remaining to update before the instance refresh | ||
| 67 | is complete. | ||
| 68 | |||
| 69 | |||
| 70 | =head2 PercentageComplete => Int | ||
| 71 | |||
| 72 | The percentage of the instance refresh that is complete. For each | ||
| 73 | instance replacement, Amazon EC2 Auto Scaling tracks the instance's | ||
| 74 | health status and warm-up time. When the instance's health status | ||
| 75 | changes to healthy and the specified warm-up time passes, the instance | ||
| 76 | is considered updated and is added to the percentage complete. | ||
| 77 | |||
| 78 | |||
| 79 | =head2 ProgressDetails => L<Paws::AutoScaling::InstanceRefreshProgressDetails> | ||
| 80 | |||
| 81 | Additional progress details for an Auto Scaling group that has a warm | ||
| 82 | pool. | ||
| 83 | |||
| 84 | |||
| 85 | =head2 StartTime => Str | ||
| 86 | |||
| 87 | The date and time at which the instance refresh began. | ||
| 88 | |||
| 89 | |||
| 90 | =head2 Status => Str | ||
| 91 | |||
| 92 | The current status for the instance refresh operation: | ||
| 93 | |||
| 94 | =over | ||
| 95 | |||
| 96 | =item * | ||
| 97 | |||
| 98 | C<Pending> - The request was created, but the operation has not | ||
| 99 | started. | ||
| 100 | |||
| 101 | =item * | ||
| 102 | |||
| 103 | C<InProgress> - The operation is in progress. | ||
| 104 | |||
| 105 | =item * | ||
| 106 | |||
| 107 | C<Successful> - The operation completed successfully. | ||
| 108 | |||
| 109 | =item * | ||
| 110 | |||
| 111 | C<Failed> - The operation failed to complete. You can troubleshoot | ||
| 112 | using the status reason and the scaling activities. | ||
| 113 | |||
| 114 | =item * | ||
| 115 | |||
| 116 | C<Cancelling> - An ongoing operation is being cancelled. Cancellation | ||
| 117 | does not roll back any replacements that have already been completed, | ||
| 118 | but it prevents new replacements from being started. | ||
| 119 | |||
| 120 | =item * | ||
| 121 | |||
| 122 | C<Cancelled> - The operation is cancelled. | ||
| 123 | |||
| 124 | =back | ||
| 125 | |||
| 126 | |||
| 127 | |||
| 128 | =head2 StatusReason => Str | ||
| 129 | |||
| 130 | Provides more details about the current status of the instance refresh. | ||
| 131 | |||
| 132 | |||
| 133 | |||
| 134 | =head1 SEE ALSO | ||
| 135 | |||
| 136 | This class forms part of L<Paws>, describing an object used in L<Paws::AutoScaling> | ||
| 137 | |||
| 138 | =head1 BUGS and CONTRIBUTIONS | ||
| 139 | |||
| 140 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 141 | |||
| 142 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 143 | |||
| 144 | =cut | ||
| 145 |