com.amazonaws.services.autoscaling.model.LifecycleHookSpecification Maven / Gradle / Ivy
/*
* Copyright 2014-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.autoscaling.model;
import java.io.Serializable;
import javax.annotation.Generated;
/**
*
* Describes a lifecycle hook. Used in combination with CreateAutoScalingGroup.
*
*
* 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:
*
*
* -
*
* (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.
*
*
* -
*
* (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.
*
*
* -
*
* Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate.
*
*
* -
*
* If you need more time, record the lifecycle action heartbeat to keep the instance in a pending state using using
* RecordLifecycleActionHeartbeat.
*
*
* -
*
* If you finish before the timeout period ends, complete the lifecycle action using CompleteLifecycleAction.
*
*
*
*
* For more information, see Amazon
* EC2 Auto Scaling Lifecycle Hooks in the Amazon EC2 Auto Scaling User Guide.
*
*
* You can view the lifecycle hooks for an Auto Scaling group using DescribeLifecycleHooks. You can modify an
* existing lifecycle hook or create new lifecycle hooks using PutLifecycleHook. If you are no longer using a
* lifecycle hook, you can delete it using DeleteLifecycleHook.
*
*
* @see AWS API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class LifecycleHookSpecification implements Serializable, Cloneable {
/**
*
* The name of the lifecycle hook.
*
*/
private String lifecycleHookName;
/**
*
* 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
*
*
*
*/
private String lifecycleTransition;
/**
*
* Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to the
* notification target.
*
*/
private String notificationMetadata;
/**
*
* 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.
*
*/
private Integer heartbeatTimeout;
/**
*
* 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.
*
*/
private String defaultResult;
/**
*
* 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.
*
*/
private String notificationTargetARN;
/**
*
* 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.
*
*/
private String roleARN;
/**
*
* The name of the lifecycle hook.
*
*
* @param lifecycleHookName
* The name of the lifecycle hook.
*/
public void setLifecycleHookName(String lifecycleHookName) {
this.lifecycleHookName = lifecycleHookName;
}
/**
*
* The name of the lifecycle hook.
*
*
* @return The name of the lifecycle hook.
*/
public String getLifecycleHookName() {
return this.lifecycleHookName;
}
/**
*
* The name of the lifecycle hook.
*
*
* @param lifecycleHookName
* The name of the lifecycle hook.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public LifecycleHookSpecification withLifecycleHookName(String lifecycleHookName) {
setLifecycleHookName(lifecycleHookName);
return this;
}
/**
*
* 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
*
*
*
*
* @param 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
*
*
*/
public void setLifecycleTransition(String lifecycleTransition) {
this.lifecycleTransition = 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
*
*
*
*
* @return 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
*
*
*/
public String getLifecycleTransition() {
return this.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
*
*
*
*
* @param 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
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public LifecycleHookSpecification withLifecycleTransition(String lifecycleTransition) {
setLifecycleTransition(lifecycleTransition);
return this;
}
/**
*
* Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to the
* notification target.
*
*
* @param notificationMetadata
* Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to the
* notification target.
*/
public void setNotificationMetadata(String notificationMetadata) {
this.notificationMetadata = notificationMetadata;
}
/**
*
* Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to the
* notification target.
*
*
* @return Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to the
* notification target.
*/
public String getNotificationMetadata() {
return this.notificationMetadata;
}
/**
*
* Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to the
* notification target.
*
*
* @param notificationMetadata
* Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to the
* notification target.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public LifecycleHookSpecification withNotificationMetadata(String notificationMetadata) {
setNotificationMetadata(notificationMetadata);
return this;
}
/**
*
* 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.
*
*
* @param 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.
*/
public void setHeartbeatTimeout(Integer heartbeatTimeout) {
this.heartbeatTimeout = 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.
*
*
* @return 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.
*/
public Integer getHeartbeatTimeout() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public LifecycleHookSpecification withHeartbeatTimeout(Integer heartbeatTimeout) {
setHeartbeatTimeout(heartbeatTimeout);
return this;
}
/**
*
* 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.
*
*
* @param 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.
*/
public void setDefaultResult(String defaultResult) {
this.defaultResult = 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.
*
*
* @return 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.
*/
public String getDefaultResult() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public LifecycleHookSpecification withDefaultResult(String defaultResult) {
setDefaultResult(defaultResult);
return this;
}
/**
*
* 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.
*
*
* @param 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.
*/
public void setNotificationTargetARN(String notificationTargetARN) {
this.notificationTargetARN = 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.
*
*
* @return 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.
*/
public String getNotificationTargetARN() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public LifecycleHookSpecification withNotificationTargetARN(String notificationTargetARN) {
setNotificationTargetARN(notificationTargetARN);
return this;
}
/**
*
* 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.
*
*
* @param 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.
*/
public void setRoleARN(String roleARN) {
this.roleARN = 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.
*
*
* @return 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.
*/
public String getRoleARN() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public LifecycleHookSpecification withRoleARN(String roleARN) {
setRoleARN(roleARN);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getLifecycleHookName() != null)
sb.append("LifecycleHookName: ").append(getLifecycleHookName()).append(",");
if (getLifecycleTransition() != null)
sb.append("LifecycleTransition: ").append(getLifecycleTransition()).append(",");
if (getNotificationMetadata() != null)
sb.append("NotificationMetadata: ").append(getNotificationMetadata()).append(",");
if (getHeartbeatTimeout() != null)
sb.append("HeartbeatTimeout: ").append(getHeartbeatTimeout()).append(",");
if (getDefaultResult() != null)
sb.append("DefaultResult: ").append(getDefaultResult()).append(",");
if (getNotificationTargetARN() != null)
sb.append("NotificationTargetARN: ").append(getNotificationTargetARN()).append(",");
if (getRoleARN() != null)
sb.append("RoleARN: ").append(getRoleARN());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof LifecycleHookSpecification == false)
return false;
LifecycleHookSpecification other = (LifecycleHookSpecification) obj;
if (other.getLifecycleHookName() == null ^ this.getLifecycleHookName() == null)
return false;
if (other.getLifecycleHookName() != null && other.getLifecycleHookName().equals(this.getLifecycleHookName()) == false)
return false;
if (other.getLifecycleTransition() == null ^ this.getLifecycleTransition() == null)
return false;
if (other.getLifecycleTransition() != null && other.getLifecycleTransition().equals(this.getLifecycleTransition()) == false)
return false;
if (other.getNotificationMetadata() == null ^ this.getNotificationMetadata() == null)
return false;
if (other.getNotificationMetadata() != null && other.getNotificationMetadata().equals(this.getNotificationMetadata()) == false)
return false;
if (other.getHeartbeatTimeout() == null ^ this.getHeartbeatTimeout() == null)
return false;
if (other.getHeartbeatTimeout() != null && other.getHeartbeatTimeout().equals(this.getHeartbeatTimeout()) == false)
return false;
if (other.getDefaultResult() == null ^ this.getDefaultResult() == null)
return false;
if (other.getDefaultResult() != null && other.getDefaultResult().equals(this.getDefaultResult()) == false)
return false;
if (other.getNotificationTargetARN() == null ^ this.getNotificationTargetARN() == null)
return false;
if (other.getNotificationTargetARN() != null && other.getNotificationTargetARN().equals(this.getNotificationTargetARN()) == false)
return false;
if (other.getRoleARN() == null ^ this.getRoleARN() == null)
return false;
if (other.getRoleARN() != null && other.getRoleARN().equals(this.getRoleARN()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getLifecycleHookName() == null) ? 0 : getLifecycleHookName().hashCode());
hashCode = prime * hashCode + ((getLifecycleTransition() == null) ? 0 : getLifecycleTransition().hashCode());
hashCode = prime * hashCode + ((getNotificationMetadata() == null) ? 0 : getNotificationMetadata().hashCode());
hashCode = prime * hashCode + ((getHeartbeatTimeout() == null) ? 0 : getHeartbeatTimeout().hashCode());
hashCode = prime * hashCode + ((getDefaultResult() == null) ? 0 : getDefaultResult().hashCode());
hashCode = prime * hashCode + ((getNotificationTargetARN() == null) ? 0 : getNotificationTargetARN().hashCode());
hashCode = prime * hashCode + ((getRoleARN() == null) ? 0 : getRoleARN().hashCode());
return hashCode;
}
@Override
public LifecycleHookSpecification clone() {
try {
return (LifecycleHookSpecification) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
}