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   630 use Moose;
  1         3  
  1         37  
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   7190 use MooseX::ClassAttribute;
  1         3  
  1         13  
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 amount of time, in seconds, that can elapse before the lifecycle
62             hook times out. When the lifecycle hook times out, Auto Scaling
63             performs the default action. You can prevent the lifecycle hook from
64             timing out by calling RecordLifecycleActionHeartbeat. The default is
65             3600 seconds (1 hour).
66              
67              
68              
69             =head2 B<REQUIRED> LifecycleHookName => Str
70              
71             The name of the lifecycle hook.
72              
73              
74              
75             =head2 LifecycleTransition => Str
76              
77             The instance state to which you want to attach the lifecycle hook. For
78             a list of lifecycle hook types, see DescribeLifecycleHookTypes.
79              
80             This parameter is required for new lifecycle hooks, but optional when
81             updating existing hooks.
82              
83              
84              
85             =head2 NotificationMetadata => Str
86              
87             Contains additional information that you want to include any time Auto
88             Scaling sends a message to the notification target.
89              
90              
91              
92             =head2 NotificationTargetARN => Str
93              
94             The ARN of the notification target that Auto Scaling will use to notify
95             you when an instance is in the transition state for the lifecycle hook.
96             This target can be either an SQS queue or an SNS topic. If you specify
97             an empty string, this overrides the current ARN.
98              
99             This operation uses the JSON format when sending notifications to an
100             Amazon SQS queue, and an email key/value pair format when sending
101             notifications to an Amazon SNS topic.
102              
103             When you specify a notification target, Auto Scaling sends it a test
104             message. Test messages contains the following additional key/value
105             pair: C<"Event": "autoscaling:TEST_NOTIFICATION">.
106              
107              
108              
109             =head2 RoleARN => Str
110              
111             The ARN of the IAM role that allows the Auto Scaling group to publish
112             to the specified notification target.
113              
114             This parameter is required for new lifecycle hooks, but optional when
115             updating existing hooks.
116              
117              
118              
119              
120             =head1 SEE ALSO
121              
122             This class forms part of L<Paws>, documenting arguments for method PutLifecycleHook in L<Paws::AutoScaling>
123              
124             =head1 BUGS and CONTRIBUTIONS
125              
126             The source code is located here: https://github.com/pplu/aws-sdk-perl
127              
128             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
129              
130             =cut
131