blib/lib/Paws/AutoScaling/LifecycleHookSpecification.pm untested

filter: Statementstmt 0.0% 0 / 10 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 1 Podpod n/a totaltotal 0.0% 0 / 11 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
CRAP 2.0
1 # Generated by default/object.tt
2 package Paws::AutoScaling::LifecycleHookSpecification;
3 use Moose;
4 has DefaultResult => (is => 'ro', isa => 'Str');
5 has HeartbeatTimeout => (is => 'ro', isa => 'Int');
6 has LifecycleHookName => (is => 'ro', isa => 'Str', required => 1);
7 has LifecycleTransition => (is => 'ro', isa => 'Str', required => 1);
8 has NotificationMetadata => (is => 'ro', isa => 'Str');
9 has NotificationTargetARN => (is => 'ro', isa => 'Str');
10 has RoleARN => (is => 'ro', isa => 'Str');
11  
12 1;
13  
14 ### main pod documentation begin ###
15  
16 =head1 NAME
17  
18 Paws::AutoScaling::LifecycleHookSpecification
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::LifecycleHookSpecification object:
30  
31 $service_obj->Method(Att1 => { DefaultResult => $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::LifecycleHookSpecification object:
36  
37 $result = $service_obj->Method(...);
38 $result->Att1->DefaultResult
39  
40 =head1 DESCRIPTION
41  
42 Describes information used to specify a lifecycle hook for an Auto
43 Scaling group.
44  
45 A lifecycle hook tells Amazon EC2 Auto Scaling to perform an action on
46 an instance when the instance launches (before it is put into service)
47 or as the instance terminates (before it is fully terminated).
48  
49 This step is a part of the procedure for creating a lifecycle hook for
50 an Auto Scaling group:
51  
52 =over
53  
54 =item 1.
55  
56 (Optional) Create a Lambda function and a rule that allows CloudWatch
57 Events to invoke your Lambda function when Amazon EC2 Auto Scaling
58 launches or terminates instances.
59  
60 =item 2.
61  
62 (Optional) Create a notification target and an IAM role. The target can
63 be either an Amazon SQS queue or an Amazon SNS topic. The role allows
64 Amazon EC2 Auto Scaling to publish lifecycle notifications to the
65 target.
66  
67 =item 3.
68  
69 B<Create the lifecycle hook. Specify whether the hook is used when the
70 instances launch or terminate.>
71  
72 =item 4.
73  
74 If you need more time, record the lifecycle action heartbeat to keep
75 the instance in a pending state.
76  
77 =item 5.
78  
79 If you finish before the timeout period ends, complete the lifecycle
80 action.
81  
82 =back
83  
84 For more information, see Amazon EC2 Auto Scaling lifecycle hooks
85 (https://docs.aws.amazon.com/autoscaling/ec2/userguide/lifecycle-hooks.html)
86 in the I<Amazon EC2 Auto Scaling User Guide>.
87  
88 =head1 ATTRIBUTES
89  
90  
91 =head2 DefaultResult => Str
92  
93 Defines the action the Auto Scaling group should take when the
94 lifecycle hook timeout elapses or if an unexpected failure occurs. The
95 valid values are C<CONTINUE> and C<ABANDON>. The default value is
96 C<ABANDON>.
97  
98  
99 =head2 HeartbeatTimeout => Int
100  
101 The maximum time, in seconds, that can elapse before the lifecycle hook
102 times out.
103  
104 If the lifecycle hook times out, Amazon EC2 Auto Scaling performs the
105 action that you specified in the C<DefaultResult> parameter. You can
106 prevent the lifecycle hook from timing out by calling
107 RecordLifecycleActionHeartbeat.
108  
109  
110 =head2 B<REQUIRED> LifecycleHookName => Str
111  
112 The name of the lifecycle hook.
113  
114  
115 =head2 B<REQUIRED> LifecycleTransition => Str
116  
117 The state of the EC2 instance to which you want to attach the lifecycle
118 hook. The valid values are:
119  
120 =over
121  
122 =item *
123  
124 autoscaling:EC2_INSTANCE_LAUNCHING
125  
126 =item *
127  
128 autoscaling:EC2_INSTANCE_TERMINATING
129  
130 =back
131  
132  
133  
134 =head2 NotificationMetadata => Str
135  
136 Additional information that you want to include any time Amazon EC2
137 Auto Scaling sends a message to the notification target.
138  
139  
140 =head2 NotificationTargetARN => Str
141  
142 The ARN of the target that Amazon EC2 Auto Scaling sends notifications
143 to when an instance is in the transition state for the lifecycle hook.
144 The notification target can be either an SQS queue or an SNS topic.
145  
146  
147 =head2 RoleARN => Str
148  
149 The ARN of the IAM role that allows the Auto Scaling group to publish
150 to the specified notification target, for example, an Amazon SNS topic
151 or an Amazon SQS queue.
152  
153  
154  
155 =head1 SEE ALSO
156  
157 This class forms part of L<Paws>, describing an object used in L<Paws::AutoScaling>
158  
159 =head1 BUGS and CONTRIBUTIONS
160  
161 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
162  
163 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
164  
165 =cut
166