« blib/lib/Paws/Lightsail/InstanceHardware.pm
↑ Summary
blib/lib/Paws/Lightsail/InstanceNetworking.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Lightsail::InstanceHealthSummary; | ||
| 3 | use Moose; | ||
| 4 | has InstanceHealth => (is => 'ro', isa => 'Str', request_name => 'instanceHealth', traits => ['NameInRequest']); | ||
| 5 | has InstanceHealthReason => (is => 'ro', isa => 'Str', request_name => 'instanceHealthReason', traits => ['NameInRequest']); | ||
| 6 | has InstanceName => (is => 'ro', isa => 'Str', request_name => 'instanceName', traits => ['NameInRequest']); | ||
| 7 | |||
| 8 | 1; | ||
| 9 | |||
| 10 | ### main pod documentation begin ### | ||
| 11 | |||
| 12 | =head1 NAME | ||
| 13 | |||
| 14 | Paws::Lightsail::InstanceHealthSummary | ||
| 15 | |||
| 16 | =head1 USAGE | ||
| 17 | |||
| 18 | This class represents one of two things: | ||
| 19 | |||
| 20 | =head3 Arguments in a call to a service | ||
| 21 | |||
| 22 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 23 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 24 | |||
| 25 | As an example, if Att1 is expected to be a Paws::Lightsail::InstanceHealthSummary object: | ||
| 26 | |||
| 27 | $service_obj->Method(Att1 => { InstanceHealth => $value, ..., InstanceName => $value }); | ||
| 28 | |||
| 29 | =head3 Results returned from an API call | ||
| 30 | |||
| 31 | Use accessors for each attribute. If Att1 is expected to be an Paws::Lightsail::InstanceHealthSummary object: | ||
| 32 | |||
| 33 | $result = $service_obj->Method(...); | ||
| 34 | $result->Att1->InstanceHealth | ||
| 35 | |||
| 36 | =head1 DESCRIPTION | ||
| 37 | |||
| 38 | Describes information about the health of the instance. | ||
| 39 | |||
| 40 | =head1 ATTRIBUTES | ||
| 41 | |||
| 42 | |||
| 43 | =head2 InstanceHealth => Str | ||
| 44 | |||
| 45 | Describes the overall instance health. Valid values are below. | ||
| 46 | |||
| 47 | |||
| 48 | =head2 InstanceHealthReason => Str | ||
| 49 | |||
| 50 | More information about the instance health. If the C<instanceHealth> is | ||
| 51 | C<healthy>, then an C<instanceHealthReason> value is not provided. | ||
| 52 | |||
| 53 | If B< C<instanceHealth> > is C<initial>, the B< C<instanceHealthReason> | ||
| 54 | > value can be one of the following: | ||
| 55 | |||
| 56 | =over | ||
| 57 | |||
| 58 | =item * | ||
| 59 | |||
| 60 | B<C<Lb.RegistrationInProgress> > - The target instance is in the | ||
| 61 | process of being registered with the load balancer. | ||
| 62 | |||
| 63 | =item * | ||
| 64 | |||
| 65 | B<C<Lb.InitialHealthChecking> > - The Lightsail load balancer is still | ||
| 66 | sending the target instance the minimum number of health checks | ||
| 67 | required to determine its health status. | ||
| 68 | |||
| 69 | =back | ||
| 70 | |||
| 71 | If B< C<instanceHealth> > is C<unhealthy>, the B< | ||
| 72 | C<instanceHealthReason> > value can be one of the following: | ||
| 73 | |||
| 74 | =over | ||
| 75 | |||
| 76 | =item * | ||
| 77 | |||
| 78 | B<C<Instance.ResponseCodeMismatch> > - The health checks did not return | ||
| 79 | an expected HTTP code. | ||
| 80 | |||
| 81 | =item * | ||
| 82 | |||
| 83 | B<C<Instance.Timeout> > - The health check requests timed out. | ||
| 84 | |||
| 85 | =item * | ||
| 86 | |||
| 87 | B<C<Instance.FailedHealthChecks> > - The health checks failed because | ||
| 88 | the connection to the target instance timed out, the target instance | ||
| 89 | response was malformed, or the target instance failed the health check | ||
| 90 | for an unknown reason. | ||
| 91 | |||
| 92 | =item * | ||
| 93 | |||
| 94 | B<C<Lb.InternalError> > - The health checks failed due to an internal | ||
| 95 | error. | ||
| 96 | |||
| 97 | =back | ||
| 98 | |||
| 99 | If B< C<instanceHealth> > is C<unused>, the B< C<instanceHealthReason> | ||
| 100 | > value can be one of the following: | ||
| 101 | |||
| 102 | =over | ||
| 103 | |||
| 104 | =item * | ||
| 105 | |||
| 106 | B<C<Instance.NotRegistered> > - The target instance is not registered | ||
| 107 | with the target group. | ||
| 108 | |||
| 109 | =item * | ||
| 110 | |||
| 111 | B<C<Instance.NotInUse> > - The target group is not used by any load | ||
| 112 | balancer, or the target instance is in an Availability Zone that is not | ||
| 113 | enabled for its load balancer. | ||
| 114 | |||
| 115 | =item * | ||
| 116 | |||
| 117 | B<C<Instance.IpUnusable> > - The target IP address is reserved for use | ||
| 118 | by a Lightsail load balancer. | ||
| 119 | |||
| 120 | =item * | ||
| 121 | |||
| 122 | B<C<Instance.InvalidState> > - The target is in the stopped or | ||
| 123 | terminated state. | ||
| 124 | |||
| 125 | =back | ||
| 126 | |||
| 127 | If B< C<instanceHealth> > is C<draining>, the B< | ||
| 128 | C<instanceHealthReason> > value can be one of the following: | ||
| 129 | |||
| 130 | =over | ||
| 131 | |||
| 132 | =item * | ||
| 133 | |||
| 134 | B<C<Instance.DeregistrationInProgress> > - The target instance is in | ||
| 135 | the process of being deregistered and the deregistration delay period | ||
| 136 | has not expired. | ||
| 137 | |||
| 138 | =back | ||
| 139 | |||
| 140 | |||
| 141 | |||
| 142 | =head2 InstanceName => Str | ||
| 143 | |||
| 144 | The name of the Lightsail instance for which you are requesting health | ||
| 145 | check data. | ||
| 146 | |||
| 147 | |||
| 148 | |||
| 149 | =head1 SEE ALSO | ||
| 150 | |||
| 151 | This class forms part of L<Paws>, describing an object used in L<Paws::Lightsail> | ||
| 152 | |||
| 153 | =head1 BUGS and CONTRIBUTIONS | ||
| 154 | |||
| 155 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 156 | |||
| 157 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 158 | |||
| 159 | =cut | ||
| 160 |