File Coverage

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