File Coverage

blib/lib/Paws/AutoScaling/SetInstanceHealth.pm
Criterion Covered Total %
statement 6 6 100.0
branch n/a
condition n/a
subroutine 2 2 100.0
pod n/a
total 8 8 100.0


line stmt bran cond sub pod time code
1              
2             package Paws::AutoScaling::SetInstanceHealth;
3 1     1   652 use Moose;
  1         3  
  1         8  
4             has HealthStatus => (is => 'ro', isa => 'Str', required => 1);
5             has InstanceId => (is => 'ro', isa => 'Str', required => 1);
6             has ShouldRespectGracePeriod => (is => 'ro', isa => 'Bool');
7              
8 1     1   8524 use MooseX::ClassAttribute;
  1         4  
  1         15  
9              
10             class_has _api_call => (isa => 'Str', is => 'ro', default => 'SetInstanceHealth');
11             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::API::Response');
12             class_has _result_key => (isa => 'Str', is => 'ro');
13             1;
14              
15             ### main pod documentation begin ###
16              
17             =head1 NAME
18              
19             Paws::AutoScaling::SetInstanceHealth - Arguments for method SetInstanceHealth on Paws::AutoScaling
20              
21             =head1 DESCRIPTION
22              
23             This class represents the parameters used for calling the method SetInstanceHealth on the
24             Auto Scaling service. Use the attributes of this class
25             as arguments to method SetInstanceHealth.
26              
27             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to SetInstanceHealth.
28              
29             As an example:
30              
31             $service_obj->SetInstanceHealth(Att1 => $value1, Att2 => $value2, ...);
32              
33             Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object.
34              
35             =head1 ATTRIBUTES
36              
37              
38             =head2 B<REQUIRED> HealthStatus => Str
39              
40             The health status of the instance. Set to C<Healthy> if you want the
41             instance to remain in service. Set to C<Unhealthy> if you want the
42             instance to be out of service. Auto Scaling will terminate and replace
43             the unhealthy instance.
44              
45              
46              
47             =head2 B<REQUIRED> InstanceId => Str
48              
49             The ID of the instance.
50              
51              
52              
53             =head2 ShouldRespectGracePeriod => Bool
54              
55             If the Auto Scaling group of the specified instance has a
56             C<HealthCheckGracePeriod> specified for the group, by default, this
57             call will respect the grace period. Set this to C<False>, if you do not
58             want the call to respect the grace period associated with the group.
59              
60             For more information, see the description of the health check grace
61             period for CreateAutoScalingGroup.
62              
63              
64              
65              
66             =head1 SEE ALSO
67              
68             This class forms part of L<Paws>, documenting arguments for method SetInstanceHealth in L<Paws::AutoScaling>
69              
70             =head1 BUGS and CONTRIBUTIONS
71              
72             The source code is located here: https://github.com/pplu/aws-sdk-perl
73              
74             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
75              
76             =cut
77