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