com.amazonaws.services.autoscaling.model

Class PutLifecycleHookRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.autoscaling.model.PutLifecycleHookRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class PutLifecycleHookRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the PutLifecycleHook operation.

Creates or updates a lifecycle hook for the specified Auto Scaling Group.

A lifecycle hook tells Auto Scaling that you want to perform an action on an instance that is not actively in service; for example, either when the instance launches or before the instance terminates.

This operation is a part of the basic sequence for adding a lifecycle hook to an Auto Scaling group:

1. Create a notification target. A target can be either an Amazon SQS queue or an Amazon SNS topic.
2. Create an IAM role. This role allows Auto Scaling to publish lifecycle notifications to the designated SQS queue or SNS topic.
3. Create the lifecycle hook. You can create a hook that acts when instances launch or when instances terminate.
4. If necessary, record the lifecycle action heartbeat to keep the instance in a pending state.
5. Complete the lifecycle action.

For more information, see Auto Scaling Pending State and Auto Scaling Terminating State in the Auto Scaling Developer Guide .

If you exceed your maximum limit of lifecycle hooks, which by default is 50 per region, the call fails. For information about updating this limit, see AWS Service Limits in the Amazon Web Services General Reference .

See Also:

AmazonAutoScaling.putLifecycleHook(PutLifecycleHookRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
PutLifecycleHookRequest()

Method Summary

Methods

Modifier and Type	Method and Description
PutLifecycleHookRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
String	getAutoScalingGroupName() The name of the Auto Scaling group to which you want to assign 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	getHeartbeatTimeout() Defines the amount of time, in seconds, that can elapse before the lifecycle hook times out.
String	getLifecycleHookName() The name of the lifecycle hook.
String	getLifecycleTransition() The instance state to which you want to attach the lifecycle hook.
String	getNotificationMetadata() Contains additional information that you want to include any time Auto Scaling sends a message to the notification target.
String	getNotificationTargetARN() The ARN of the notification target that Auto Scaling will use to notify you 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 to which you want to assign 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	setHeartbeatTimeout(Integer heartbeatTimeout) Defines the amount of 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 instance state to which you want to attach the lifecycle hook.
void	setNotificationMetadata(String notificationMetadata) Contains additional information that you want to include any time Auto Scaling sends a message to the notification target.
void	setNotificationTargetARN(String notificationTargetARN) The ARN of the notification target that Auto Scaling will use to notify you 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; useful for testing and debugging.
PutLifecycleHookRequest	withAutoScalingGroupName(String autoScalingGroupName) The name of the Auto Scaling group to which you want to assign the lifecycle hook.
PutLifecycleHookRequest	withDefaultResult(String defaultResult) Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected failure occurs.
PutLifecycleHookRequest	withHeartbeatTimeout(Integer heartbeatTimeout) Defines the amount of time, in seconds, that can elapse before the lifecycle hook times out.
PutLifecycleHookRequest	withLifecycleHookName(String lifecycleHookName) The name of the lifecycle hook.
PutLifecycleHookRequest	withLifecycleTransition(String lifecycleTransition) The instance state to which you want to attach the lifecycle hook.
PutLifecycleHookRequest	withNotificationMetadata(String notificationMetadata) Contains additional information that you want to include any time Auto Scaling sends a message to the notification target.
PutLifecycleHookRequest	withNotificationTargetARN(String notificationTargetARN) The ARN of the notification target that Auto Scaling will use to notify you when an instance is in the transition state for the lifecycle hook.
PutLifecycleHookRequest	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 com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PutLifecycleHookRequest

public PutLifecycleHookRequest()

Method Detail

getLifecycleHookName

public String getLifecycleHookName()

The name of the lifecycle hook.

Constraints:
Length: 1 - 255
Pattern: [A-Za-z0-9\-_\/]+

Returns:

The name of the lifecycle hook.

setLifecycleHookName

public void setLifecycleHookName(String lifecycleHookName)

The name of the lifecycle hook.

Constraints:
Length: 1 - 255
Pattern: [A-Za-z0-9\-_\/]+

Parameters:

lifecycleHookName - The name of the lifecycle hook.

withLifecycleHookName

public PutLifecycleHookRequest withLifecycleHookName(String lifecycleHookName)

The name of the lifecycle hook.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 255
Pattern: [A-Za-z0-9\-_\/]+

Parameters:

lifecycleHookName - The name of the lifecycle hook.

Returns:

A reference to this updated object so that method calls can be chained together.

getAutoScalingGroupName

public String getAutoScalingGroupName()

The name of the Auto Scaling group to which you want to assign the lifecycle hook.

Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Returns:

The name of the Auto Scaling group to which you want to assign the lifecycle hook.

setAutoScalingGroupName

public void setAutoScalingGroupName(String autoScalingGroupName)

The name of the Auto Scaling group to which you want to assign the lifecycle hook.

Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Parameters:

autoScalingGroupName - The name of the Auto Scaling group to which you want to assign the lifecycle hook.

withAutoScalingGroupName

public PutLifecycleHookRequest withAutoScalingGroupName(String autoScalingGroupName)

The name of the Auto Scaling group to which you want to assign the lifecycle hook.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Parameters:

autoScalingGroupName - The name of the Auto Scaling group to which you want to assign the lifecycle hook.

Returns:

A reference to this updated object so that method calls can be chained together.

getLifecycleTransition

public String getLifecycleTransition()

The instance state to which you want to attach the lifecycle hook. For a list of lifecycle hook types, see DescribeLifecycleHookTypes.

This parameter is required for new lifecycle hooks, but optional when updating existing hooks.

Returns:

The instance state to which you want to attach the lifecycle hook. For a list of lifecycle hook types, see DescribeLifecycleHookTypes.

This parameter is required for new lifecycle hooks, but optional when updating existing hooks.

setLifecycleTransition

public void setLifecycleTransition(String lifecycleTransition)

The instance state to which you want to attach the lifecycle hook. For a list of lifecycle hook types, see DescribeLifecycleHookTypes.

This parameter is required for new lifecycle hooks, but optional when updating existing hooks.

Parameters:

lifecycleTransition - The instance state to which you want to attach the lifecycle hook. For a list of lifecycle hook types, see DescribeLifecycleHookTypes.

This parameter is required for new lifecycle hooks, but optional when updating existing hooks.

withLifecycleTransition

public PutLifecycleHookRequest withLifecycleTransition(String lifecycleTransition)

The instance state to which you want to attach the lifecycle hook. For a list of lifecycle hook types, see DescribeLifecycleHookTypes.

This parameter is required for new lifecycle hooks, but optional when updating existing hooks.

Returns a reference to this object so that method calls can be chained together.

Parameters:

lifecycleTransition - The instance state to which you want to attach the lifecycle hook. For a list of lifecycle hook types, see DescribeLifecycleHookTypes.

This parameter is required for new lifecycle hooks, but optional when updating existing hooks.

Returns:

A reference to this updated object so that method calls can be chained together.

getRoleARN

public String getRoleARN()

The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target.

This parameter is required for new lifecycle hooks, but optional when updating existing hooks.

Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Returns:

The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target.

This parameter is required for new lifecycle hooks, but optional when updating existing hooks.

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.

This parameter is required for new lifecycle hooks, but optional when updating existing hooks.

Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Parameters:

roleARN - The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target.

This parameter is required for new lifecycle hooks, but optional when updating existing hooks.

withRoleARN

public PutLifecycleHookRequest withRoleARN(String roleARN)

The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target.

This parameter is required for new lifecycle hooks, but optional when updating existing hooks.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Parameters:

roleARN - The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target.

This parameter is required for new lifecycle hooks, but optional when updating existing hooks.

Returns:

A reference to this updated object so that method calls can be chained together.

getNotificationTargetARN

public String getNotificationTargetARN()

The ARN of the notification target that Auto Scaling will use to notify you when an instance is in the transition state for the lifecycle hook. This ARN target can be either an SQS queue or an SNS topic.

This parameter is required for new lifecycle hooks, but optional when updating existing hooks.

The notification message sent to the target will include:

• LifecycleActionToken. The Lifecycle action token.
• AccountId. The user account ID.
• AutoScalingGroupName. The name of the Auto Scaling group.
• LifecycleHookName. The lifecycle hook name.
• EC2InstanceId. The EC2 instance ID.
• LifecycleTransition. The lifecycle transition.
• NotificationMetadata. The notification metadata.

This operation uses the JSON format when sending notifications to an Amazon SQS queue, and an email key/value pair format when sending notifications to an Amazon SNS topic.

When you call this operation, a test message is sent to the notification target. This test message contains an additional key/value pair: Event:autoscaling:TEST_NOTIFICATION.

Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Returns:

The ARN of the notification target that Auto Scaling will use to notify you when an instance is in the transition state for the lifecycle hook. This ARN target can be either an SQS queue or an SNS topic.

This parameter is required for new lifecycle hooks, but optional when updating existing hooks.

The notification message sent to the target will include:

• LifecycleActionToken. The Lifecycle action token.
• AccountId. The user account ID.
• AutoScalingGroupName. The name of the Auto Scaling group.
• LifecycleHookName. The lifecycle hook name.
• EC2InstanceId. The EC2 instance ID.
• LifecycleTransition. The lifecycle transition.
• NotificationMetadata. The notification metadata.

This operation uses the JSON format when sending notifications to an Amazon SQS queue, and an email key/value pair format when sending notifications to an Amazon SNS topic.

When you call this operation, a test message is sent to the notification target. This test message contains an additional key/value pair: Event:autoscaling:TEST_NOTIFICATION.

setNotificationTargetARN

public void setNotificationTargetARN(String notificationTargetARN)

The ARN of the notification target that Auto Scaling will use to notify you when an instance is in the transition state for the lifecycle hook. This ARN target can be either an SQS queue or an SNS topic.

This parameter is required for new lifecycle hooks, but optional when updating existing hooks.

The notification message sent to the target will include:

• LifecycleActionToken. The Lifecycle action token.
• AccountId. The user account ID.
• AutoScalingGroupName. The name of the Auto Scaling group.
• LifecycleHookName. The lifecycle hook name.
• EC2InstanceId. The EC2 instance ID.
• LifecycleTransition. The lifecycle transition.
• NotificationMetadata. The notification metadata.

This operation uses the JSON format when sending notifications to an Amazon SQS queue, and an email key/value pair format when sending notifications to an Amazon SNS topic.

When you call this operation, a test message is sent to the notification target. This test message contains an additional key/value pair: Event:autoscaling:TEST_NOTIFICATION.

Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Parameters:

notificationTargetARN - The ARN of the notification target that Auto Scaling will use to notify you when an instance is in the transition state for the lifecycle hook. This ARN target can be either an SQS queue or an SNS topic.

This parameter is required for new lifecycle hooks, but optional when updating existing hooks.

The notification message sent to the target will include:

• LifecycleActionToken. The Lifecycle action token.
• AccountId. The user account ID.
• AutoScalingGroupName. The name of the Auto Scaling group.
• LifecycleHookName. The lifecycle hook name.
• EC2InstanceId. The EC2 instance ID.
• LifecycleTransition. The lifecycle transition.
• NotificationMetadata. The notification metadata.

This operation uses the JSON format when sending notifications to an Amazon SQS queue, and an email key/value pair format when sending notifications to an Amazon SNS topic.

When you call this operation, a test message is sent to the notification target. This test message contains an additional key/value pair: Event:autoscaling:TEST_NOTIFICATION.

withNotificationTargetARN

public PutLifecycleHookRequest withNotificationTargetARN(String notificationTargetARN)

The ARN of the notification target that Auto Scaling will use to notify you when an instance is in the transition state for the lifecycle hook. This ARN target can be either an SQS queue or an SNS topic.

This parameter is required for new lifecycle hooks, but optional when updating existing hooks.

The notification message sent to the target will include:

• LifecycleActionToken. The Lifecycle action token.
• AccountId. The user account ID.
• AutoScalingGroupName. The name of the Auto Scaling group.
• LifecycleHookName. The lifecycle hook name.
• EC2InstanceId. The EC2 instance ID.
• LifecycleTransition. The lifecycle transition.
• NotificationMetadata. The notification metadata.

This operation uses the JSON format when sending notifications to an Amazon SQS queue, and an email key/value pair format when sending notifications to an Amazon SNS topic.

When you call this operation, a test message is sent to the notification target. This test message contains an additional key/value pair: Event:autoscaling:TEST_NOTIFICATION.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 1600
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Parameters:

notificationTargetARN - The ARN of the notification target that Auto Scaling will use to notify you when an instance is in the transition state for the lifecycle hook. This ARN target can be either an SQS queue or an SNS topic.

This parameter is required for new lifecycle hooks, but optional when updating existing hooks.

The notification message sent to the target will include:

• LifecycleActionToken. The Lifecycle action token.
• AccountId. The user account ID.
• AutoScalingGroupName. The name of the Auto Scaling group.
• LifecycleHookName. The lifecycle hook name.
• EC2InstanceId. The EC2 instance ID.
• LifecycleTransition. The lifecycle transition.
• NotificationMetadata. The notification metadata.

This operation uses the JSON format when sending notifications to an Amazon SQS queue, and an email key/value pair format when sending notifications to an Amazon SNS topic.

When you call this operation, a test message is sent to the notification target. This test message contains an additional key/value pair: Event:autoscaling:TEST_NOTIFICATION.

Returns:

A reference to this updated object so that method calls can be chained together.

getNotificationMetadata

public String getNotificationMetadata()

Contains additional information that you want to include any time Auto Scaling sends a message to the notification target.

Constraints:
Length: 1 - 1023
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Returns:

Contains additional information that you want to include any time Auto Scaling sends a message to the notification target.

setNotificationMetadata

public void setNotificationMetadata(String notificationMetadata)

Contains additional information that you want to include any time Auto Scaling sends a message to the notification target.

Constraints:
Length: 1 - 1023
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Parameters:

notificationMetadata - Contains additional information that you want to include any time Auto Scaling sends a message to the notification target.

withNotificationMetadata

public PutLifecycleHookRequest withNotificationMetadata(String notificationMetadata)

Contains additional information that you want to include any time Auto Scaling sends a message to the notification target.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 1023
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Parameters:

notificationMetadata - Contains additional information that you want to include any time Auto Scaling sends a message to the notification target.

Returns:

A reference to this updated object so that method calls can be chained together.

getHeartbeatTimeout

public Integer getHeartbeatTimeout()

Defines the amount of time, in seconds, that can elapse before the lifecycle hook times out. When the lifecycle hook times out, Auto Scaling performs the action defined in the DefaultResult parameter. You can prevent the lifecycle hook from timing out by calling RecordLifecycleActionHeartbeat. The default value for this parameter is 3600 seconds (1 hour).

Returns:

Defines the amount of time, in seconds, that can elapse before the lifecycle hook times out. When the lifecycle hook times out, Auto Scaling performs the action defined in the DefaultResult parameter. You can prevent the lifecycle hook from timing out by calling RecordLifecycleActionHeartbeat. The default value for this parameter is 3600 seconds (1 hour).

setHeartbeatTimeout

public void setHeartbeatTimeout(Integer heartbeatTimeout)

Defines the amount of time, in seconds, that can elapse before the lifecycle hook times out. When the lifecycle hook times out, Auto Scaling performs the action defined in the DefaultResult parameter. You can prevent the lifecycle hook from timing out by calling RecordLifecycleActionHeartbeat. The default value for this parameter is 3600 seconds (1 hour).

Parameters:

heartbeatTimeout - Defines the amount of time, in seconds, that can elapse before the lifecycle hook times out. When the lifecycle hook times out, Auto Scaling performs the action defined in the DefaultResult parameter. You can prevent the lifecycle hook from timing out by calling RecordLifecycleActionHeartbeat. The default value for this parameter is 3600 seconds (1 hour).

withHeartbeatTimeout

public PutLifecycleHookRequest withHeartbeatTimeout(Integer heartbeatTimeout)

Defines the amount of time, in seconds, that can elapse before the lifecycle hook times out. When the lifecycle hook times out, Auto Scaling performs the action defined in the DefaultResult parameter. You can prevent the lifecycle hook from timing out by calling RecordLifecycleActionHeartbeat. The default value for this parameter is 3600 seconds (1 hour).

Returns a reference to this object so that method calls can be chained together.

Parameters:

heartbeatTimeout - Defines the amount of time, in seconds, that can elapse before the lifecycle hook times out. When the lifecycle hook times out, Auto Scaling performs the action defined in the DefaultResult parameter. You can prevent the lifecycle hook from timing out by calling RecordLifecycleActionHeartbeat. The default value for this parameter is 3600 seconds (1 hour).

Returns:

A reference to this updated object so that method calls can be chained together.

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 value for this parameter can be either CONTINUE or ABANDON. The default value for this parameter 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 value for this parameter can be either CONTINUE or ABANDON. The default value for this parameter is ABANDON.

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 value for this parameter can be either CONTINUE or ABANDON. The default value for this parameter 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 value for this parameter can be either CONTINUE or ABANDON. The default value for this parameter is ABANDON.

withDefaultResult

public PutLifecycleHookRequest 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 value for this parameter can be either CONTINUE or ABANDON. The default value for this parameter is ABANDON.

Returns a reference to this object so that method calls can be chained together.

Parameters:

defaultResult - Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected failure occurs. The value for this parameter can be either CONTINUE or ABANDON. The default value for this parameter is ABANDON.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public PutLifecycleHookRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()