@Generated(value="software.amazon.awssdk:codegen") public final class LifecycleHook extends Object implements ToCopyableBuilder<LifecycleHook.Builder,LifecycleHook>
Describes a lifecycle hook, which tells Auto Scaling that you want to perform an action whenever it launches instances or whenever it terminates instances.
For more information, see Auto Scaling Lifecycle Hooks in the Auto Scaling User Guide.
Modifier and Type | Class and Description |
---|---|
static interface |
LifecycleHook.Builder |
Modifier and Type | Method and Description |
---|---|
String |
autoScalingGroupName()
The name of the Auto Scaling group for the lifecycle hook.
|
static LifecycleHook.Builder |
builder() |
String |
defaultResult()
Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected
failure occurs.
|
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
Integer |
globalTimeout()
The maximum time, in seconds, that an instance can remain in a
Pending:Wait or
Terminating:Wait state. |
int |
hashCode() |
Integer |
heartbeatTimeout()
The maximum time, in seconds, that can elapse before the lifecycle hook times out.
|
String |
lifecycleHookName()
The name of the lifecycle hook.
|
String |
lifecycleTransition()
The state of the EC2 instance to which you want to attach the lifecycle hook.
|
String |
notificationMetadata()
Additional information that you want to include any time Auto Scaling sends a message to the notification target.
|
String |
notificationTargetARN()
The ARN of the target that Auto Scaling sends notifications to when an instance is in the transition state for
the lifecycle hook.
|
String |
roleARN()
The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target.
|
static Class<? extends LifecycleHook.Builder> |
serializableBuilderClass() |
LifecycleHook.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
copy
public String lifecycleHookName()
The name of the lifecycle hook.
public String autoScalingGroupName()
The name of the Auto Scaling group for the lifecycle hook.
public String lifecycleTransition()
The state of the EC2 instance to which you want to attach the lifecycle hook. For a list of lifecycle hook types, see DescribeLifecycleHookTypes.
public String notificationTargetARN()
The ARN of the target that 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.
public String roleARN()
The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target.
public String notificationMetadata()
Additional information that you want to include any time Auto Scaling sends a message to the notification target.
public Integer heartbeatTimeout()
The maximum time, in seconds, that can elapse before the lifecycle hook times out. If the lifecycle hook times out, Auto Scaling performs the default action. You can prevent the lifecycle hook from timing out by calling RecordLifecycleActionHeartbeat.
public Integer globalTimeout()
The maximum time, in seconds, that an instance can remain in a Pending:Wait
or
Terminating:Wait
state. The maximum is 172800 seconds (48 hours) or 100 times
HeartbeatTimeout
, whichever is smaller.
Pending:Wait
or
Terminating:Wait
state. The maximum is 172800 seconds (48 hours) or 100 times
HeartbeatTimeout
, whichever is smaller.public String defaultResult()
Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected
failure occurs. The valid values are CONTINUE
and ABANDON
. The default value is
CONTINUE
.
CONTINUE
and ABANDON
. The
default value is CONTINUE
.public LifecycleHook.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<LifecycleHook.Builder,LifecycleHook>
public static LifecycleHook.Builder builder()
public static Class<? extends LifecycleHook.Builder> serializableBuilderClass()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.