software.amazon.awssdk.services.autoscaling.model

Class LifecycleHookSpecification

java.lang.Object

software.amazon.awssdk.services.autoscaling.model.LifecycleHookSpecification

All Implemented Interfaces:

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

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

Describes information used to specify a lifecycle hook for an Auto Scaling group.

A lifecycle hook tells Amazon EC2 Auto Scaling to perform an action on an instance when the instance launches (before it is put into service) or as the instance terminates (before it is fully terminated).

This step is a part of the procedure for creating a lifecycle hook for an Auto Scaling group:

1. (Optional) Create a Lambda function and a rule that allows CloudWatch Events to invoke your Lambda function when Amazon EC2 Auto Scaling launches or terminates instances.

2. (Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish lifecycle notifications to the target.

3. Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate.

4. If you need more time, record the lifecycle action heartbeat to keep the instance in a pending state.

5. If you finish before the timeout period ends, complete the lifecycle action.

For more information, see Amazon EC2 Auto Scaling 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	LifecycleHookSpecification.Builder

Method Summary

Modifier and Type	Method and Description
static LifecycleHookSpecification.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)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
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 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, for example, an Amazon SNS topic or an Amazon SQS queue.
List<SdkField<?>>	sdkFields()
static Class<? extends LifecycleHookSpecification.Builder>	serializableBuilderClass()
LifecycleHookSpecification.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, 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.

lifecycleTransition

public String lifecycleTransition()

The state of the EC2 instance to which you want to attach the lifecycle hook. The valid values are:

• autoscaling:EC2_INSTANCE_LAUNCHING

• autoscaling:EC2_INSTANCE_TERMINATING

Returns:

The state of the EC2 instance to which you want to attach the lifecycle hook. The valid values are:

• autoscaling:EC2_INSTANCE_LAUNCHING

• autoscaling:EC2_INSTANCE_TERMINATING

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 action that you specified in the DefaultResult parameter. 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 action that you specified in the DefaultResult parameter. You can prevent the lifecycle hook from timing out by calling RecordLifecycleActionHeartbeat.

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 ABANDON.

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 ABANDON.

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, for example, an Amazon SNS topic or an Amazon SQS queue.

Returns:

The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target, for example, an Amazon SNS topic or an Amazon SQS queue.

toBuilder

public LifecycleHookSpecification.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<LifecycleHookSpecification.Builder,LifecycleHookSpecification>

builder

public static LifecycleHookSpecification.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

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