Package software.amazon.awssdk.services.autoscaling.model

Class LifecycleHook

java.lang.Object

software.amazon.awssdk.services.autoscaling.model.LifecycleHook

All Implemented Interfaces:

ToCopyableBuilder<LifecycleHook.Builder,LifecycleHook>

@Generated("software.amazon.awssdk:codegen")
public class LifecycleHook
extends Object
implements ToCopyableBuilder<LifecycleHook.Builder,LifecycleHook>

Describes a lifecycle hook, which tells Auto Scaling that you want to perform an action when an instance launches or terminates. When you have a lifecycle hook in place, the Auto Scaling group will either:

• Pause the instance after it launches, but before it is put into service

• Pause the instance as it terminates, but before it is fully terminated

For more information, see Auto Scaling Lifecycle in the Auto Scaling User Guide.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	LifecycleHook.Builder

Method Summary

Modifier and Type	Method	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)
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 notification target that Auto Scaling uses to notify you 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()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

lifecycleHookName

public String lifecycleHookName()

The name of the lifecycle hook.

Returns:

The name of the lifecycle hook.

autoScalingGroupName

public String autoScalingGroupName()

The name of the Auto Scaling group for the lifecycle hook.

Returns:

The name of the Auto Scaling group for the lifecycle hook.

lifecycleTransition

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.

Returns:

The state of the EC2 instance to which you want to attach the lifecycle hook. For a list of lifecycle hook types, see DescribeLifecycleHookTypes.

notificationTargetARN

public String notificationTargetARN()

The ARN of the notification target that Auto Scaling uses to notify you when an instance is in the transition state for the lifecycle hook. This ARN target can be either an SQS queue or an SNS topic. The notification message sent to the target includes the following:

• Lifecycle action token

• User account ID

• Name of the Auto Scaling group

• Lifecycle hook name

• EC2 instance ID

• Lifecycle transition

• Notification metadata

Returns:

The ARN of the notification target that Auto Scaling uses to notify you when an instance is in the transition state for the lifecycle hook. This ARN target can be either an SQS queue or an SNS topic. The notification message sent to the target includes the following:

• Lifecycle action token

• User account ID

• Name of the Auto Scaling group

• Lifecycle hook name

• EC2 instance ID

• Lifecycle transition

• Notification metadata

roleARN

public String roleARN()

The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target.

Returns:

The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target.

notificationMetadata

public String notificationMetadata()

Additional information that you want to include any time Auto Scaling sends a message to the notification target.

Returns:

Additional information that you want to include any time Auto Scaling sends a message to the notification target.

heartbeatTimeout

public Integer heartbeatTimeout()

The maximum time, in seconds, that can elapse before the lifecycle hook times out. The default is 3600 seconds (1 hour). When the lifecycle hook times out, Auto Scaling performs the default action. You can prevent the lifecycle hook from timing out by calling RecordLifecycleActionHeartbeat.

Returns:

The maximum time, in seconds, that can elapse before the lifecycle hook times out. The default is 3600 seconds (1 hour). When the lifecycle hook times out, Auto Scaling performs the default action. You can prevent the lifecycle hook from timing out by calling RecordLifecycleActionHeartbeat.

globalTimeout

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.

Returns:

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.

defaultResult

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.

Returns:

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.

toBuilder

public LifecycleHook.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<LifecycleHook.Builder,LifecycleHook>

Returns:

a builder for type T

builder

public static LifecycleHook.Builder builder()

serializableBuilderClass

public static Class<? extends LifecycleHook.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object