File Coverage

blib/lib/Paws/AutoScaling/PutLifecycleHook.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::PutLifecycleHook;
3 1     1   483 use Moose;
  1         3  
  1         8  
4             has AutoScalingGroupName => (is => 'ro', isa => 'Str', required => 1);
5             has DefaultResult => (is => 'ro', isa => 'Str');
6             has HeartbeatTimeout => (is => 'ro', isa => 'Int');
7             has LifecycleHookName => (is => 'ro', isa => 'Str', required => 1);
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              
13 1     1   6048 use MooseX::ClassAttribute;
  1         2  
  1         10  
14              
15             class_has _api_call => (isa => 'Str', is => 'ro', default => 'PutLifecycleHook');
16             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::AutoScaling::PutLifecycleHookAnswer');
17             class_has _result_key => (isa => 'Str', is => 'ro', default => 'PutLifecycleHookResult');
18             1;
19              
20             ### main pod documentation begin ###
21              
22             =head1 NAME
23              
24             Paws::AutoScaling::PutLifecycleHook - Arguments for method PutLifecycleHook on Paws::AutoScaling
25              
26             =head1 DESCRIPTION
27              
28             This class represents the parameters used for calling the method PutLifecycleHook on the
29             Auto Scaling service. Use the attributes of this class
30             as arguments to method PutLifecycleHook.
31              
32             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to PutLifecycleHook.
33              
34             As an example:
35              
36             $service_obj->PutLifecycleHook(Att1 => $value1, Att2 => $value2, ...);
37              
38             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.
39              
40             =head1 ATTRIBUTES
41              
42              
43             =head2 B<REQUIRED> AutoScalingGroupName => Str
44              
45             The name of the Auto Scaling group to which you want to assign the
46             lifecycle hook.
47              
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. This
54             parameter can be either C<CONTINUE> or C<ABANDON>. The default value is
55             C<ABANDON>.
56              
57              
58              
59             =head2 HeartbeatTimeout => Int
60              
61             The maximum time, in seconds, that can elapse before the lifecycle hook
62             times out. The range is from 30 to 7200 seconds. The default is 3600
63             seconds (1 hour).
64              
65             If the lifecycle hook times out, Auto Scaling performs the default
66             action. You can prevent the lifecycle hook from timing out by calling
67             RecordLifecycleActionHeartbeat.
68              
69              
70              
71             =head2 B<REQUIRED> LifecycleHookName => Str
72              
73             The name of the lifecycle hook.
74              
75              
76              
77             =head2 LifecycleTransition => Str
78              
79             The instance state to which you want to attach the lifecycle hook. For
80             a list of lifecycle hook types, see DescribeLifecycleHookTypes.
81              
82             This parameter is required for new lifecycle hooks, but optional when
83             updating existing hooks.
84              
85              
86              
87             =head2 NotificationMetadata => Str
88              
89             Contains additional information that you want to include any time Auto
90             Scaling sends a message to the notification target.
91              
92              
93              
94             =head2 NotificationTargetARN => Str
95              
96             The ARN of the notification target that Auto Scaling will use to notify
97             you when an instance is in the transition state for the lifecycle hook.
98             This target can be either an SQS queue or an SNS topic. If you specify
99             an empty string, this overrides the current ARN.
100              
101             This operation uses the JSON format when sending notifications to an
102             Amazon SQS queue, and an email key/value pair format when sending
103             notifications to an Amazon SNS topic.
104              
105             When you specify a notification target, Auto Scaling sends it a test
106             message. Test messages contains the following additional key/value
107             pair: C<"Event": "autoscaling:TEST_NOTIFICATION">.
108              
109              
110              
111             =head2 RoleARN => Str
112              
113             The ARN of the IAM role that allows the Auto Scaling group to publish
114             to the specified notification target.
115              
116             This parameter is required for new lifecycle hooks, but optional when
117             updating existing hooks.
118              
119              
120              
121              
122             =head1 SEE ALSO
123              
124             This class forms part of L<Paws>, documenting arguments for method PutLifecycleHook in L<Paws::AutoScaling>
125              
126             =head1 BUGS and CONTRIBUTIONS
127              
128             The source code is located here: https://github.com/pplu/aws-sdk-perl
129              
130             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
131              
132             =cut
133