File Coverage

blib/lib/Paws/AutoScaling/LoadBalancerState.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::AutoScaling::LoadBalancerState;
2 1     1   491 use Moose;
  1         3  
  1         8  
3             has LoadBalancerName => (is => 'ro', isa => 'Str');
4             has State => (is => 'ro', isa => 'Str');
5             1;
6              
7             ### main pod documentation begin ###
8              
9             =head1 NAME
10              
11             Paws::AutoScaling::LoadBalancerState
12              
13             =head1 USAGE
14              
15             This class represents one of two things:
16              
17             =head3 Arguments in a call to a service
18              
19             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
20             Each attribute should be used as a named argument in the calls that expect this type of object.
21              
22             As an example, if Att1 is expected to be a Paws::AutoScaling::LoadBalancerState object:
23              
24             $service_obj->Method(Att1 => { LoadBalancerName => $value, ..., State => $value });
25              
26             =head3 Results returned from an API call
27              
28             Use accessors for each attribute. If Att1 is expected to be an Paws::AutoScaling::LoadBalancerState object:
29              
30             $result = $service_obj->Method(...);
31             $result->Att1->LoadBalancerName
32              
33             =head1 DESCRIPTION
34              
35             Describes the state of a Classic Load Balancer.
36              
37             If you specify a load balancer when creating the Auto Scaling group,
38             the state of the load balancer is C<InService>.
39              
40             If you attach a load balancer to an existing Auto Scaling group, the
41             initial state is C<Adding>. The state transitions to C<Added> after all
42             instances in the group are registered with the load balancer. If ELB
43             health checks are enabled for the load balancer, the state transitions
44             to C<InService> after at least one instance in the group passes the
45             health check. If EC2 health checks are enabled instead, the load
46             balancer remains in the C<Added> state.
47              
48             =head1 ATTRIBUTES
49              
50              
51             =head2 LoadBalancerName => Str
52              
53             The name of the load balancer.
54              
55              
56             =head2 State => Str
57              
58             One of the following load balancer states:
59              
60             =over
61              
62             =item *
63              
64             C<Adding> - The instances in the group are being registered with the
65             load balancer.
66              
67             =item *
68              
69             C<Added> - All instances in the group are registered with the load
70             balancer.
71              
72             =item *
73              
74             C<InService> - At least one instance in the group passed an ELB health
75             check.
76              
77             =item *
78              
79             C<Removing> - The instances in the group are being deregistered from
80             the load balancer. If connection draining is enabled, Elastic Load
81             Balancing waits for in-flight requests to complete before deregistering
82             the instances.
83              
84             =item *
85              
86             C<Removed> - All instances in the group are deregistered from the load
87             balancer.
88              
89             =back
90              
91              
92              
93              
94             =head1 SEE ALSO
95              
96             This class forms part of L<Paws>, describing an object used in L<Paws::AutoScaling>
97              
98             =head1 BUGS and CONTRIBUTIONS
99              
100             The source code is located here: https://github.com/pplu/aws-sdk-perl
101              
102             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
103              
104             =cut
105