com.amazonaws.services.autoscaling.model

Class PutLifecycleHookRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.autoscaling.model.PutLifecycleHookRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class PutLifecycleHookRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
PutLifecycleHookRequest()

Method Summary

Modifier and Type	Method and Description
PutLifecycleHookRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getAutoScalingGroupName() The name of the Auto Scaling group.
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 instance state 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 notification target that Amazon EC2 Auto Scaling uses 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.
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 instance state 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 notification target that Amazon EC2 Auto Scaling uses 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.
PutLifecycleHookRequest	withAutoScalingGroupName(String autoScalingGroupName) The name of the Auto Scaling group.
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) The maximum 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) Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to the notification target.
PutLifecycleHookRequest	withNotificationTargetARN(String notificationTargetARN) The ARN of the notification target that Amazon EC2 Auto Scaling uses 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

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PutLifecycleHookRequest

public PutLifecycleHookRequest()

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 PutLifecycleHookRequest 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.

Parameters:

autoScalingGroupName - The name of the Auto Scaling group.

getAutoScalingGroupName

public String getAutoScalingGroupName()

The name of the Auto Scaling group.

Returns:

The name of the Auto Scaling group.

withAutoScalingGroupName

public PutLifecycleHookRequest withAutoScalingGroupName(String autoScalingGroupName)

The name of the Auto Scaling group.

Parameters:

autoScalingGroupName - The name of the Auto Scaling group.

Returns:

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

setLifecycleTransition

public void setLifecycleTransition(String lifecycleTransition)

The instance state to which you want to attach the lifecycle hook. The valid values are:

• autoscaling:EC2_INSTANCE_LAUNCHING

• autoscaling:EC2_INSTANCE_TERMINATING

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. The valid values are:

• autoscaling:EC2_INSTANCE_LAUNCHING

• autoscaling:EC2_INSTANCE_TERMINATING

Required for new lifecycle hooks, but optional when updating existing hooks.

getLifecycleTransition

public String getLifecycleTransition()

The instance state to which you want to attach the lifecycle hook. The valid values are:

• autoscaling:EC2_INSTANCE_LAUNCHING

• autoscaling:EC2_INSTANCE_TERMINATING

Required for new lifecycle hooks, but optional when updating existing hooks.

Returns:

The instance state to which you want to attach the lifecycle hook. The valid values are:

• autoscaling:EC2_INSTANCE_LAUNCHING

• autoscaling:EC2_INSTANCE_TERMINATING

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. The valid values are:

• autoscaling:EC2_INSTANCE_LAUNCHING

• autoscaling:EC2_INSTANCE_TERMINATING

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. The valid values are:

• autoscaling:EC2_INSTANCE_LAUNCHING

• autoscaling:EC2_INSTANCE_TERMINATING

Required for new lifecycle hooks, but optional when updating existing hooks.

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.

Valid only if the notification target is an Amazon SNS topic or an Amazon SQS queue. Required for new lifecycle hooks, but optional when updating existing hooks.

Parameters:

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

Valid only if the notification target is an Amazon SNS topic or an Amazon SQS queue. Required for new lifecycle hooks, but optional when updating existing hooks.

getRoleARN

public String getRoleARN()

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

Valid only if the notification target is an Amazon SNS topic or an Amazon SQS queue. Required for new lifecycle hooks, but optional when updating existing hooks.

Returns:

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

Valid only if the notification target is an Amazon SNS topic or an Amazon SQS queue. 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.

Valid only if the notification target is an Amazon SNS topic or an Amazon SQS queue. Required for new lifecycle hooks, but optional when updating existing hooks.

Parameters:

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

Valid only if the notification target is an Amazon SNS topic or an Amazon SQS queue. Required for new lifecycle hooks, but optional when updating existing hooks.

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 notification target that Amazon EC2 Auto Scaling uses to notify you when an instance is in the transition state for the lifecycle hook. This target can be either an SQS queue or an SNS topic.

If you specify an empty string, this overrides the current ARN.

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 specify a notification target, Amazon EC2 Auto Scaling sends it a test message. Test messages contain the following additional key-value pair: "Event": "autoscaling:TEST_NOTIFICATION".

Parameters:

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

If you specify an empty string, this overrides the current ARN.

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 specify a notification target, Amazon EC2 Auto Scaling sends it a test message. Test messages contain the following additional key-value pair: "Event": "autoscaling:TEST_NOTIFICATION".

getNotificationTargetARN

public String getNotificationTargetARN()

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

If you specify an empty string, this overrides the current ARN.

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 specify a notification target, Amazon EC2 Auto Scaling sends it a test message. Test messages contain the following additional key-value pair: "Event": "autoscaling:TEST_NOTIFICATION".

Returns:

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

If you specify an empty string, this overrides the current ARN.

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 specify a notification target, Amazon EC2 Auto Scaling sends it a test message. Test messages contain the following additional key-value pair: "Event": "autoscaling:TEST_NOTIFICATION".

withNotificationTargetARN

public PutLifecycleHookRequest withNotificationTargetARN(String notificationTargetARN)

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

If you specify an empty string, this overrides the current ARN.

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 specify a notification target, Amazon EC2 Auto Scaling sends it a test message. Test messages contain the following additional key-value pair: "Event": "autoscaling:TEST_NOTIFICATION".

Parameters:

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

If you specify an empty string, this overrides the current ARN.

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 specify a notification target, Amazon EC2 Auto Scaling sends it a test message. Test messages contain the following additional key-value pair: "Event": "autoscaling:TEST_NOTIFICATION".

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 PutLifecycleHookRequest 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. The range is from 30 to 7200 seconds. The default value is 3600 seconds (1 hour).

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 the RecordLifecycleActionHeartbeat API.

Parameters:

heartbeatTimeout - The maximum time, in seconds, that can elapse before the lifecycle hook times out. The range is from 30 to 7200 seconds. The default value is 3600 seconds (1 hour).

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 the RecordLifecycleActionHeartbeat API.

getHeartbeatTimeout

public Integer getHeartbeatTimeout()

The maximum time, in seconds, that can elapse before the lifecycle hook times out. The range is from 30 to 7200 seconds. The default value is 3600 seconds (1 hour).

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 the RecordLifecycleActionHeartbeat API.

Returns:

The maximum time, in seconds, that can elapse before the lifecycle hook times out. The range is from 30 to 7200 seconds. The default value is 3600 seconds (1 hour).

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 the RecordLifecycleActionHeartbeat API.

withHeartbeatTimeout

public PutLifecycleHookRequest withHeartbeatTimeout(Integer heartbeatTimeout)

The maximum time, in seconds, that can elapse before the lifecycle hook times out. The range is from 30 to 7200 seconds. The default value is 3600 seconds (1 hour).

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 the RecordLifecycleActionHeartbeat API.

Parameters:

heartbeatTimeout - The maximum time, in seconds, that can elapse before the lifecycle hook times out. The range is from 30 to 7200 seconds. The default value is 3600 seconds (1 hour).

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 the RecordLifecycleActionHeartbeat API.

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. This parameter can be either CONTINUE or 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. This parameter can be either CONTINUE or 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. This parameter can be either CONTINUE or 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. This parameter can be either CONTINUE or ABANDON. The default value 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. This parameter can be either CONTINUE or 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. This parameter can be either CONTINUE or ABANDON. The default value is 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 PutLifecycleHookRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()