File Coverage

blib/lib/Paws/ELB/HealthCheck.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	sub	time	code
1				package Paws::ELB::HealthCheck;
2	1	1	591	use Moose;
	1		3
	1		9
3				has HealthyThreshold => (is => 'ro', isa => 'Int', required => 1);
4				has Interval => (is => 'ro', isa => 'Int', required => 1);
5				has Target => (is => 'ro', isa => 'Str', required => 1);
6				has Timeout => (is => 'ro', isa => 'Int', required => 1);
7				has UnhealthyThreshold => (is => 'ro', isa => 'Int', required => 1);
8				1;
9
10				### main pod documentation begin ###
11
12				=head1 NAME
13
14				Paws::ELB::HealthCheck
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::ELB::HealthCheck object:
26
27				$service_obj->Method(Att1 => { HealthyThreshold => $value, ..., UnhealthyThreshold => $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::ELB::HealthCheck object:
32
33				$result = $service_obj->Method(...);
34				$result->Att1->HealthyThreshold
35
36				=head1 DESCRIPTION
37
38				Information about a health check.
39
40				=head1 ATTRIBUTES
41
42
43				=head2 B<REQUIRED> HealthyThreshold => Int
44
45				The number of consecutive health checks successes required before
46				moving the instance to the C<Healthy> state.
47
48
49				=head2 B<REQUIRED> Interval => Int
50
51				The approximate interval, in seconds, between health checks of an
52				individual instance.
53
54
55				=head2 B<REQUIRED> Target => Str
56
57				The instance being checked. The protocol is either TCP, HTTP, HTTPS, or
58				SSL. The range of valid ports is one (1) through 65535.
59
60				TCP is the default, specified as a TCP: port pair, for example
61				"TCP:5000". In this case, a health check simply attempts to open a TCP
62				connection to the instance on the specified port. Failure to connect
63				within the configured timeout is considered unhealthy.
64
65				SSL is also specified as SSL: port pair, for example, SSL:5000.
66
67				For HTTP/HTTPS, you must include a ping path in the string. HTTP is
68				specified as a HTTP:port;/;PathToPing; grouping, for example
69				"HTTP:80/weather/us/wa/seattle". In this case, a HTTP GET request is
70				issued to the instance on the given port and path. Any answer other
71				than "200 OK" within the timeout period is considered unhealthy.
72
73				The total length of the HTTP ping target must be 1024 16-bit Unicode
74				characters or less.
75
76
77				=head2 B<REQUIRED> Timeout => Int
78
79				The amount of time, in seconds, during which no response means a failed
80				health check.
81
82				This value must be less than the C<Interval> value.
83
84
85				=head2 B<REQUIRED> UnhealthyThreshold => Int
86
87				The number of consecutive health check failures required before moving
88				the instance to the C<Unhealthy> state.
89
90
91
92				=head1 SEE ALSO
93
94				This class forms part of L<Paws>, describing an object used in L<Paws::ELB>
95
96				=head1 BUGS and CONTRIBUTIONS
97
98				The source code is located here: https://github.com/pplu/aws-sdk-perl
99
100				Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
101
102				=cut
103