File Coverage

blib/lib/Paws/AutoScaling/LifecycleHook.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::LifecycleHook;
2 1     1   443 use Moose;
  1         2  
  1         8  
3             has AutoScalingGroupName => (is => 'ro', isa => 'Str');
4             has DefaultResult => (is => 'ro', isa => 'Str');
5             has GlobalTimeout => (is => 'ro', isa => 'Int');
6             has HeartbeatTimeout => (is => 'ro', isa => 'Int');
7             has LifecycleHookName => (is => 'ro', isa => 'Str');
8             has LifecycleTransition => (is => 'ro', isa => 'Str');
9             has NotificationMetadata => (is => 'ro', isa => 'Str');
10             has NotificationTargetARN => (is => 'ro', isa => 'Str');
11             has RoleARN => (is => 'ro', isa => 'Str');
12             1;
13              
14             ### main pod documentation begin ###
15              
16             =head1 NAME
17              
18             Paws::AutoScaling::LifecycleHook
19              
20             =head1 USAGE
21              
22             This class represents one of two things:
23              
24             =head3 Arguments in a call to a service
25              
26             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
27             Each attribute should be used as a named argument in the calls that expect this type of object.
28              
29             As an example, if Att1 is expected to be a Paws::AutoScaling::LifecycleHook object:
30              
31             $service_obj->Method(Att1 => { AutoScalingGroupName => $value, ..., RoleARN => $value });
32              
33             =head3 Results returned from an API call
34              
35             Use accessors for each attribute. If Att1 is expected to be an Paws::AutoScaling::LifecycleHook object:
36              
37             $result = $service_obj->Method(...);
38             $result->Att1->AutoScalingGroupName
39              
40             =head1 DESCRIPTION
41              
42             Describes a lifecycle hook, which tells Auto Scaling that you want to
43             perform an action whenever it launches instances or whenever it
44             terminates instances.
45              
46             For more information, see Auto Scaling Lifecycle Hooks in the I<Auto
47             Scaling User Guide>.
48              
49             =head1 ATTRIBUTES
50              
51              
52             =head2 AutoScalingGroupName => Str
53              
54             The name of the Auto Scaling group for the lifecycle hook.
55              
56              
57             =head2 DefaultResult => Str
58              
59             Defines the action the Auto Scaling group should take when the
60             lifecycle hook timeout elapses or if an unexpected failure occurs. The
61             valid values are C<CONTINUE> and C<ABANDON>. The default value is
62             C<CONTINUE>.
63              
64              
65             =head2 GlobalTimeout => Int
66              
67             The maximum time, in seconds, that an instance can remain in a
68             C<Pending:Wait> or C<Terminating:Wait> state. The maximum is 172800
69             seconds (48 hours) or 100 times C<HeartbeatTimeout>, whichever is
70             smaller.
71              
72              
73             =head2 HeartbeatTimeout => Int
74              
75             The maximum time, in seconds, that can elapse before the lifecycle hook
76             times out. If the lifecycle hook times out, Auto Scaling performs the
77             default action. You can prevent the lifecycle hook from timing out by
78             calling RecordLifecycleActionHeartbeat.
79              
80              
81             =head2 LifecycleHookName => Str
82              
83             The name of the lifecycle hook.
84              
85              
86             =head2 LifecycleTransition => Str
87              
88             The state of the EC2 instance to which you want to attach the lifecycle
89             hook. For a list of lifecycle hook types, see
90             DescribeLifecycleHookTypes.
91              
92              
93             =head2 NotificationMetadata => Str
94              
95             Additional information that you want to include any time Auto Scaling
96             sends a message to the notification target.
97              
98              
99             =head2 NotificationTargetARN => Str
100              
101             The ARN of the target that Auto Scaling sends notifications to when an
102             instance is in the transition state for the lifecycle hook. The
103             notification target can be either an SQS queue or an SNS topic.
104              
105              
106             =head2 RoleARN => Str
107              
108             The ARN of the IAM role that allows the Auto Scaling group to publish
109             to the specified notification target.
110              
111              
112              
113             =head1 SEE ALSO
114              
115             This class forms part of L<Paws>, describing an object used in L<Paws::AutoScaling>
116              
117             =head1 BUGS and CONTRIBUTIONS
118              
119             The source code is located here: https://github.com/pplu/aws-sdk-perl
120              
121             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
122              
123             =cut
124