com.amazonaws.services.autoscaling.model

Class RecordLifecycleActionHeartbeatRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.autoscaling.model.RecordLifecycleActionHeartbeatRequest

All Implemented Interfaces:

Serializable

public class RecordLifecycleActionHeartbeatRequest
extends AmazonWebServiceRequest
implements Serializable

Container for the parameters to the RecordLifecycleActionHeartbeat operation.

Records a heartbeat for the lifecycle action associated with a specific token. This extends the timeout by the length of time defined by the HeartbeatTimeout parameter of the PutLifecycleHook operation.

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.

To learn more, see Auto Scaling Pending State and Auto Scaling Terminating State .

See Also:

AmazonAutoScaling.recordLifecycleActionHeartbeat(RecordLifecycleActionHeartbeatRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
RecordLifecycleActionHeartbeatRequest()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getAutoScalingGroupName() The name of the Auto Scaling group to which the hook belongs.
String	getLifecycleActionToken() A token that uniquely identifies a specific lifecycle action associated with an instance.
String	getLifecycleHookName() The name of the lifecycle hook.
int	hashCode()
void	setAutoScalingGroupName(String autoScalingGroupName) The name of the Auto Scaling group to which the hook belongs.
void	setLifecycleActionToken(String lifecycleActionToken) A token that uniquely identifies a specific lifecycle action associated with an instance.
void	setLifecycleHookName(String lifecycleHookName) The name of the lifecycle hook.
String	toString() Returns a string representation of this object; useful for testing and debugging.
RecordLifecycleActionHeartbeatRequest	withAutoScalingGroupName(String autoScalingGroupName) The name of the Auto Scaling group to which the hook belongs.
RecordLifecycleActionHeartbeatRequest	withLifecycleActionToken(String lifecycleActionToken) A token that uniquely identifies a specific lifecycle action associated with an instance.
RecordLifecycleActionHeartbeatRequest	withLifecycleHookName(String lifecycleHookName) The name of the lifecycle hook.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, copyPrivateRequestParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

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

Constructor Detail

RecordLifecycleActionHeartbeatRequest

public RecordLifecycleActionHeartbeatRequest()

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 RecordLifecycleActionHeartbeatRequest 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 the hook belongs.

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 the hook belongs.

setAutoScalingGroupName

public void setAutoScalingGroupName(String autoScalingGroupName)

The name of the Auto Scaling group to which the hook belongs.

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 the hook belongs.

withAutoScalingGroupName

public RecordLifecycleActionHeartbeatRequest withAutoScalingGroupName(String autoScalingGroupName)

The name of the Auto Scaling group to which the hook belongs.

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 the hook belongs.

Returns:

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

getLifecycleActionToken

public String getLifecycleActionToken()

A token that uniquely identifies a specific lifecycle action associated with an instance. Auto Scaling sends this token to the notification target you specified when you created the lifecycle hook.

Constraints:
Length: 36 - 36

Returns:

A token that uniquely identifies a specific lifecycle action associated with an instance. Auto Scaling sends this token to the notification target you specified when you created the lifecycle hook.

setLifecycleActionToken

public void setLifecycleActionToken(String lifecycleActionToken)

A token that uniquely identifies a specific lifecycle action associated with an instance. Auto Scaling sends this token to the notification target you specified when you created the lifecycle hook.

Constraints:
Length: 36 - 36

Parameters:

lifecycleActionToken - A token that uniquely identifies a specific lifecycle action associated with an instance. Auto Scaling sends this token to the notification target you specified when you created the lifecycle hook.

withLifecycleActionToken

public RecordLifecycleActionHeartbeatRequest withLifecycleActionToken(String lifecycleActionToken)

A token that uniquely identifies a specific lifecycle action associated with an instance. Auto Scaling sends this token to the notification target you specified when you created the lifecycle hook.

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

Constraints:
Length: 36 - 36

Parameters:

lifecycleActionToken - A token that uniquely identifies a specific lifecycle action associated with an instance. Auto Scaling sends this token to the notification target you specified when you created the lifecycle hook.

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