File Coverage

blib/lib/Paws/ELBv2/TargetHealth.pm
Criterion Covered Total %
statement 3 3 100.0
branch n/a
condition n/a
subroutine 1 1 100.0
pod n/a
total 4 4 100.0


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