software.amazon.awssdk.services.autoscaling.model

Class LifecycleHook

java.lang.Object

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

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<LifecycleHook.Builder,LifecycleHook>

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

Describes a lifecycle hook, which tells Amazon EC2 Auto Scaling that you want to perform an action whenever it launches instances or whenever it terminates instances.

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	LifecycleHook.Builder

Method Summary

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 to attach the lifecycle hook.
String	notificationMetadata() Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to the notification target.
String	notificationTargetARN() 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.
String	roleARN() The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target.
List<SdkField<?>>	sdkFields()
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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

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 to attach the lifecycle hook. The following are possible values:

• autoscaling:EC2_INSTANCE_LAUNCHING

• autoscaling:EC2_INSTANCE_TERMINATING

Returns:

The state of the EC2 instance to which to attach the lifecycle hook. The following are possible values:

• autoscaling:EC2_INSTANCE_LAUNCHING

• autoscaling:EC2_INSTANCE_TERMINATING

notificationTargetARN

public String notificationTargetARN()

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.

Returns:

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.

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 Amazon EC2 Auto Scaling sends a message to the notification target.

Returns:

Additional information that you want to include any time Amazon EC2 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. If the lifecycle hook times out, Amazon EC2 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. If the lifecycle hook times out, Amazon EC2 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

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.