LifecycleHook (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.autoscaling.model.LifecycleHook

All Implemented Interfaces:

Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class LifecycleHook
extends Object
implements Serializable, Cloneable
```
Describes a lifecycle hook, which tells Amazon EC2 Auto Scaling that you want to perform an action whenever it launches instances or terminates instances.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

LifecycleHook()

Constructors
Constructor and Description
`LifecycleHook()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`LifecycleHook`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getAutoScalingGroupName()` The name of the Auto Scaling group for the lifecycle hook.
`String`	`getDefaultResult()` Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected failure occurs.
`Integer`	`getGlobalTimeout()` The maximum time, in seconds, that an instance can remain in a `Pending:Wait` or `Terminating:Wait` state.
`Integer`	`getHeartbeatTimeout()` The maximum time, in seconds, that can elapse before the lifecycle hook times out.
`String`	`getLifecycleHookName()` The name of the lifecycle hook.
`String`	`getLifecycleTransition()` The state of the EC2 instance to which to attach the lifecycle hook.
`String`	`getNotificationMetadata()` Additional information that is included any time Amazon EC2 Auto Scaling sends a message to the notification target.
`String`	`getNotificationTargetARN()` 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`	`getRoleARN()` The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target.
`int`	`hashCode()`
`void`	`setAutoScalingGroupName(String autoScalingGroupName)` The name of the Auto Scaling group for the lifecycle hook.
`void`	`setDefaultResult(String defaultResult)` Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected failure occurs.
`void`	`setGlobalTimeout(Integer globalTimeout)` The maximum time, in seconds, that an instance can remain in a `Pending:Wait` or `Terminating:Wait` state.
`void`	`setHeartbeatTimeout(Integer heartbeatTimeout)` The maximum time, in seconds, that can elapse before the lifecycle hook times out.
`void`	`setLifecycleHookName(String lifecycleHookName)` The name of the lifecycle hook.
`void`	`setLifecycleTransition(String lifecycleTransition)` The state of the EC2 instance to which to attach the lifecycle hook.
`void`	`setNotificationMetadata(String notificationMetadata)` Additional information that is included any time Amazon EC2 Auto Scaling sends a message to the notification target.
`void`	`setNotificationTargetARN(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.
`void`	`setRoleARN(String roleARN)` The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target.
`String`	`toString()` Returns a string representation of this object.
`LifecycleHook`	`withAutoScalingGroupName(String autoScalingGroupName)` The name of the Auto Scaling group for the lifecycle hook.
`LifecycleHook`	`withDefaultResult(String defaultResult)` Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected failure occurs.
`LifecycleHook`	`withGlobalTimeout(Integer globalTimeout)` The maximum time, in seconds, that an instance can remain in a `Pending:Wait` or `Terminating:Wait` state.
`LifecycleHook`	`withHeartbeatTimeout(Integer heartbeatTimeout)` The maximum time, in seconds, that can elapse before the lifecycle hook times out.
`LifecycleHook`	`withLifecycleHookName(String lifecycleHookName)` The name of the lifecycle hook.
`LifecycleHook`	`withLifecycleTransition(String lifecycleTransition)` The state of the EC2 instance to which to attach the lifecycle hook.
`LifecycleHook`	`withNotificationMetadata(String notificationMetadata)` Additional information that is included any time Amazon EC2 Auto Scaling sends a message to the notification target.
`LifecycleHook`	`withNotificationTargetARN(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.
`LifecycleHook`	`withRoleARN(String roleARN)` The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - LifecycleHook
```
public LifecycleHook()
```
- Method Detail
  - setLifecycleHookName
```
public void setLifecycleHookName(String lifecycleHookName)
```
    The name of the lifecycle hook.
    
    Parameters:
    
    lifecycleHookName - The name of the lifecycle hook.
  - getLifecycleHookName
```
public String getLifecycleHookName()
```
    The name of the lifecycle hook.
    
    Returns:
    
    The name of the lifecycle hook.
  - withLifecycleHookName
```
public LifecycleHook withLifecycleHookName(String lifecycleHookName)
```
    The name of the lifecycle hook.
    
    Parameters:
    
    lifecycleHookName - The name of the lifecycle hook.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAutoScalingGroupName
```
public void setAutoScalingGroupName(String autoScalingGroupName)
```
    The name of the Auto Scaling group for the lifecycle hook.
    
    Parameters:
    
    autoScalingGroupName - The name of the Auto Scaling group for the lifecycle hook.
  - getAutoScalingGroupName
```
public String getAutoScalingGroupName()
```
    The name of the Auto Scaling group for the lifecycle hook.
    
    Returns:
    
    The name of the Auto Scaling group for the lifecycle hook.
  - withAutoScalingGroupName
```
public LifecycleHook withAutoScalingGroupName(String autoScalingGroupName)
```
    The name of the Auto Scaling group for the lifecycle hook.
    
    Parameters:
    
    autoScalingGroupName - The name of the Auto Scaling group for the lifecycle hook.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLifecycleTransition
```
public void setLifecycleTransition(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
    Parameters:
    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
  - getLifecycleTransition
```
public String getLifecycleTransition()
```
    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
  - withLifecycleTransition
```
public LifecycleHook withLifecycleTransition(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
    Parameters:
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setNotificationTargetARN
```
public void setNotificationTargetARN(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.
    
    Parameters:
    
    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.
  - getNotificationTargetARN
```
public String getNotificationTargetARN()
```
    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.
  - withNotificationTargetARN
```
public LifecycleHook withNotificationTargetARN(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRoleARN
```
public void setRoleARN(String roleARN)
```
    The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target.
    
    Parameters:
    
    roleARN - The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target.
  - getRoleARN
```
public String getRoleARN()
```
    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.
  - withRoleARN
```
public LifecycleHook withRoleARN(String roleARN)
```
    The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target.
    
    Parameters:
    
    roleARN - The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setNotificationMetadata
```
public void setNotificationMetadata(String notificationMetadata)
```
    Additional information that is included any time Amazon EC2 Auto Scaling sends a message to the notification target.
    
    Parameters:
    
    notificationMetadata - Additional information that is included any time Amazon EC2 Auto Scaling sends a message to the notification target.
  - getNotificationMetadata
```
public String getNotificationMetadata()
```
    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.
  - withNotificationMetadata
```
public LifecycleHook withNotificationMetadata(String notificationMetadata)
```
    Additional information that is included any time Amazon EC2 Auto Scaling sends a message to the notification target.
    
    Parameters:
    
    notificationMetadata - Additional information that is included any time Amazon EC2 Auto Scaling sends a message to the notification target.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setHeartbeatTimeout
```
public void setHeartbeatTimeout(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.
    
    Parameters:
    
    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.
  - getHeartbeatTimeout
```
public Integer getHeartbeatTimeout()
```
    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.
    
    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.
  - withHeartbeatTimeout
```
public LifecycleHook withHeartbeatTimeout(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setGlobalTimeout
```
public void setGlobalTimeout(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.
    
    Parameters:
    
    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.
  - getGlobalTimeout
```
public Integer getGlobalTimeout()
```
    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.
  - withGlobalTimeout
```
public LifecycleHook withGlobalTimeout(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDefaultResult
```
public void setDefaultResult(String defaultResult)
```
    Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected failure occurs. The possible values are CONTINUE and ABANDON.
    
    Parameters:
    
    defaultResult - Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected failure occurs. The possible values are CONTINUE and ABANDON.
  - getDefaultResult
```
public String getDefaultResult()
```
    Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected failure occurs. The possible values are CONTINUE and ABANDON.
    
    Returns:
    
    Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected failure occurs. The possible values are CONTINUE and ABANDON.
  - withDefaultResult
```
public LifecycleHook withDefaultResult(String defaultResult)
```
    Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected failure occurs. The possible values are CONTINUE and ABANDON.
    
    Parameters:
    
    defaultResult - Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected failure occurs. The possible values are CONTINUE and ABANDON.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public LifecycleHook clone()
```
    Overrides:
    
    clone in class Object

Did this page help you?

Class LifecycleHook

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

LifecycleHook

Method Detail

setLifecycleHookName

getLifecycleHookName

withLifecycleHookName

setAutoScalingGroupName

getAutoScalingGroupName

withAutoScalingGroupName

setLifecycleTransition

getLifecycleTransition

withLifecycleTransition

setNotificationTargetARN

getNotificationTargetARN

withNotificationTargetARN

setRoleARN

getRoleARN

withRoleARN

setNotificationMetadata

getNotificationMetadata

withNotificationMetadata

setHeartbeatTimeout

getHeartbeatTimeout

withHeartbeatTimeout

setGlobalTimeout

getGlobalTimeout

withGlobalTimeout

setDefaultResult

getDefaultResult

withDefaultResult

toString

equals

hashCode

clone