LifecycleHook class
Describes a lifecycle hook, which tells Amazon EC2 Auto Scaling that you want to perform an action whenever it launches instances or terminates instances.
Constructors
Properties
- autoScalingGroupName → String?
-
The name of the Auto Scaling group for the lifecycle hook.
final
- defaultResult → String?
-
Defines the action the Auto Scaling group should take when the lifecycle
hook timeout elapses or if an unexpected failure occurs. The possible values
are
CONTINUE
andABANDON
.final - globalTimeout → int?
-
The maximum time, in seconds, that an instance can remain in a
Pending:Wait
orTerminating:Wait
state. The maximum is 172800 seconds (48 hours) or 100 timesHeartbeatTimeout
, whichever is smaller.final - hashCode → int
-
The hash code for this object.
no setterinherited
- heartbeatTimeout → int?
-
The maximum time, in seconds, that can elapse before the lifecycle hook
times out. If the lifecycle hook times out, Amazon EC2 Auto Scaling performs
the action that you specified in the
DefaultResult
parameter.final - lifecycleHookName → String?
-
The name of the lifecycle hook.
final
- lifecycleTransition → String?
-
The state of the EC2 instance to which to attach the lifecycle hook. The
following are possible values:
final
- notificationMetadata → String?
-
Additional information that is included any time Amazon EC2 Auto Scaling
sends a message to the notification target.
final
- notificationTargetARN → String?
-
The ARN of the target that Amazon EC2 Auto Scaling sends notifications to
when an instance is in the transition state for the lifecycle hook. The
notification target can be either an SQS queue or an SNS topic.
final
- roleARN → String?
-
The ARN of the IAM role that allows the Auto Scaling group to publish to the
specified notification target.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited