java.lang.Object
- software.amazon.awssdk.services.autoscaling.model.LifecycleHook

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<LifecycleHook.Builder,LifecycleHook>
```
@Generated("software.amazon.awssdk:codegen")
public final class LifecycleHook
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<LifecycleHook.Builder,LifecycleHook>
```
Describes a lifecycle hook. A lifecycle hook lets you create solutions that are aware of events in the Auto Scaling instance lifecycle, and then perform a custom action on instances when the corresponding lifecycle event occurs.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface LifecycleHook.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`autoScalingGroupName()`	The name of the Auto Scaling group for the lifecycle hook.
`static LifecycleHook.Builder`	`builder()`
`String`	`defaultResult()`	The action the Auto Scaling group takes 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)`
`Integer`	`globalTimeout()`	The maximum time, in seconds, that an instance can remain in a 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 lifecycle transition.
`String`	`notificationMetadata()`	Additional information that is included 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 a wait 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 (an Amazon SNS topic or an Amazon SQS queue).
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends LifecycleHook.Builder>`	`serializableBuilderClass()`
`LifecycleHook.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 final String lifecycleHookName()
```
    The name of the lifecycle hook.
    
    Returns:
    
    The name of the lifecycle hook.
  - autoScalingGroupName
```
public final 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 final String lifecycleTransition()
```
    The lifecycle transition.
    
    Valid values: autoscaling:EC2_INSTANCE_LAUNCHING | autoscaling:EC2_INSTANCE_TERMINATING
    
    Returns:
    
    The lifecycle transition.
    
    Valid values: autoscaling:EC2_INSTANCE_LAUNCHING | autoscaling:EC2_INSTANCE_TERMINATING
  - notificationTargetARN
```
public final String notificationTargetARN()
```
    The ARN of the target that Amazon EC2 Auto Scaling sends notifications to when an instance is in a wait state for the lifecycle hook.
    
    Returns:
    
    The ARN of the target that Amazon EC2 Auto Scaling sends notifications to when an instance is in a wait state for the lifecycle hook.
  - roleARN
```
public final String roleARN()
```
    The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target (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 (an Amazon SNS topic or an Amazon SQS queue).
  - notificationMetadata
```
public final String notificationMetadata()
```
    Additional information that is included any time Amazon EC2 Auto Scaling sends a message to the notification target.
    
    Returns:
    
    Additional information that is included any time Amazon EC2 Auto Scaling sends a message to the notification target.
  - heartbeatTimeout
```
public final 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 property.
    
    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 property.
  - globalTimeout
```
public final Integer globalTimeout()
```
    The maximum time, in seconds, that an instance can remain in a 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 wait state. The maximum is 172800 seconds (48 hours) or 100 times HeartbeatTimeout, whichever is smaller.
  - defaultResult
```
public final String defaultResult()
```
    The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an unexpected failure occurs.
    
    Valid values: CONTINUE | ABANDON
    
    Returns:
    
    The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an unexpected failure occurs.
    
    Valid values: CONTINUE | ABANDON
  - toBuilder
```
public LifecycleHook.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<LifecycleHook.Builder,LifecycleHook>
  - builder
```
public static LifecycleHook.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends LifecycleHook.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final 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 final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class LifecycleHook

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

lifecycleHookName

autoScalingGroupName

lifecycleTransition

notificationTargetARN

roleARN

notificationMetadata

heartbeatTimeout

globalTimeout

defaultResult

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields