LifecycleHookSpecification (AWS SDK for Java

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

All Implemented Interfaces:

Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class LifecycleHookSpecification
extends Object
implements Serializable, Cloneable
```
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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

LifecycleHookSpecification()

Constructors
Constructor and Description
`LifecycleHookSpecification()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`LifecycleHookSpecification`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getDefaultResult()` Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected failure occurs.
`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 you want to attach the lifecycle hook.
`String`	`getNotificationMetadata()` Additional information that you want to include 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, for example, an Amazon SNS topic or an Amazon SQS queue.
`int`	`hashCode()`
`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`	`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 you want to attach the lifecycle hook.
`void`	`setNotificationMetadata(String notificationMetadata)` Additional information that you want to include 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, for example, an Amazon SNS topic or an Amazon SQS queue.
`String`	`toString()` Returns a string representation of this object.
`LifecycleHookSpecification`	`withDefaultResult(String defaultResult)` Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected failure occurs.
`LifecycleHookSpecification`	`withHeartbeatTimeout(Integer heartbeatTimeout)` The maximum time, in seconds, that can elapse before the lifecycle hook times out.
`LifecycleHookSpecification`	`withLifecycleHookName(String lifecycleHookName)` The name of the lifecycle hook.
`LifecycleHookSpecification`	`withLifecycleTransition(String lifecycleTransition)` The state of the EC2 instance to which you want to attach the lifecycle hook.
`LifecycleHookSpecification`	`withNotificationMetadata(String notificationMetadata)` Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to the notification target.
`LifecycleHookSpecification`	`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.
`LifecycleHookSpecification`	`withRoleARN(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.

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

- Constructor Detail
  - LifecycleHookSpecification
```
public LifecycleHookSpecification()
```
- 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 LifecycleHookSpecification 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.
  - setLifecycleTransition
```
public void setLifecycleTransition(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
    Parameters:
    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
  - getLifecycleTransition
```
public String getLifecycleTransition()
```
    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
  - withLifecycleTransition
```
public LifecycleHookSpecification withLifecycleTransition(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
    Parameters:
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setNotificationMetadata
```
public void setNotificationMetadata(String notificationMetadata)
```
    Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to the notification target.
    
    Parameters:
    
    notificationMetadata - Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to the notification target.
  - getNotificationMetadata
```
public String getNotificationMetadata()
```
    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.
  - withNotificationMetadata
```
public LifecycleHookSpecification withNotificationMetadata(String notificationMetadata)
```
    Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to the notification target.
    
    Parameters:
    
    notificationMetadata - Additional information that you want to include 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. You can prevent the lifecycle hook from timing out by calling RecordLifecycleActionHeartbeat.
    
    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. You can prevent the lifecycle hook from timing out by calling RecordLifecycleActionHeartbeat.
  - 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. 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.
  - withHeartbeatTimeout
```
public LifecycleHookSpecification 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. You can prevent the lifecycle hook from timing out by calling RecordLifecycleActionHeartbeat.
    
    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. You can prevent the lifecycle hook from timing out by calling RecordLifecycleActionHeartbeat.
    
    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 valid values are CONTINUE and ABANDON. The default value is 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 valid values are CONTINUE and ABANDON. The default value is 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 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.
  - withDefaultResult
```
public LifecycleHookSpecification 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 valid values are CONTINUE and ABANDON. The default value is 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 valid values are CONTINUE and ABANDON. The default value is ABANDON.
    
    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 LifecycleHookSpecification 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, for example, an Amazon SNS topic or an Amazon SQS queue.
    
    Parameters:
    
    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.
  - getRoleARN
```
public String getRoleARN()
```
    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.
  - withRoleARN
```
public LifecycleHookSpecification withRoleARN(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.
    
    Parameters:
    
    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:
    
    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 LifecycleHookSpecification clone()
```
    Overrides:
    
    clone in class Object

Did this page help you?

Class LifecycleHookSpecification

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

LifecycleHookSpecification

Method Detail

setLifecycleHookName

getLifecycleHookName

withLifecycleHookName

setLifecycleTransition

getLifecycleTransition

withLifecycleTransition

setNotificationMetadata

getNotificationMetadata

withNotificationMetadata

setHeartbeatTimeout

getHeartbeatTimeout

withHeartbeatTimeout

setDefaultResult

getDefaultResult

withDefaultResult

setNotificationTargetARN

getNotificationTargetARN

withNotificationTargetARN

setRoleARN

getRoleARN

withRoleARN

toString

equals

hashCode

clone