/* * Copyright 2018-2023 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 an EC2 instance associated with an Auto Scaling group. *
* * @see AWS API Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class AutoScalingInstanceDetails implements Serializable, Cloneable { /** ** The ID of the instance. *
*/ private String instanceId; /** ** The instance type of the EC2 instance. *
*/ private String instanceType; /** ** The name of the Auto Scaling group for the instance. *
*/ private String autoScalingGroupName; /** ** The Availability Zone for the instance. *
*/ private String availabilityZone; /** *
* The lifecycle state for the instance. The Quarantined
state is not used. For information about
* lifecycle states, see Instance
* lifecycle in the Amazon EC2 Auto Scaling User Guide.
*
* Valid values: Pending
| Pending:Wait
| Pending:Proceed
|
* Quarantined
| InService
| Terminating
| Terminating:Wait
|
* Terminating:Proceed
| Terminated
| Detaching
| Detached
|
* EnteringStandby
| Standby
| Warmed:Pending
|
* Warmed:Pending:Wait
| Warmed:Pending:Proceed
| Warmed:Terminating
|
* Warmed:Terminating:Wait
| Warmed:Terminating:Proceed
| Warmed:Terminated
|
* Warmed:Stopped
| Warmed:Running
*
* The last reported health status of this instance. Healthy
means that the instance is healthy and
* should remain in service. Unhealthy
means that the instance is unhealthy and Amazon EC2 Auto Scaling
* should terminate and replace it.
*
* The launch configuration used to launch the instance. This value is not available if you attached the instance to * the Auto Scaling group. *
*/ private String launchConfigurationName; /** ** The launch template for the instance. *
*/ private LaunchTemplateSpecification launchTemplate; /** ** Indicates whether the instance is protected from termination by Amazon EC2 Auto Scaling when scaling in. *
*/ private Boolean protectedFromScaleIn; /** ** The number of capacity units contributed by the instance based on its instance type. *
** Valid Range: Minimum value of 1. Maximum value of 999. *
*/ private String weightedCapacity; /** ** The ID of the instance. *
* * @param instanceId * The ID of the instance. */ public void setInstanceId(String instanceId) { this.instanceId = instanceId; } /** ** The ID of the instance. *
* * @return The ID of the instance. */ public String getInstanceId() { return this.instanceId; } /** ** The ID of the instance. *
* * @param instanceId * The ID of the instance. * @return Returns a reference to this object so that method calls can be chained together. */ public AutoScalingInstanceDetails withInstanceId(String instanceId) { setInstanceId(instanceId); return this; } /** ** The instance type of the EC2 instance. *
* * @param instanceType * The instance type of the EC2 instance. */ public void setInstanceType(String instanceType) { this.instanceType = instanceType; } /** ** The instance type of the EC2 instance. *
* * @return The instance type of the EC2 instance. */ public String getInstanceType() { return this.instanceType; } /** ** The instance type of the EC2 instance. *
* * @param instanceType * The instance type of the EC2 instance. * @return Returns a reference to this object so that method calls can be chained together. */ public AutoScalingInstanceDetails withInstanceType(String instanceType) { setInstanceType(instanceType); return this; } /** ** The name of the Auto Scaling group for the instance. *
* * @param autoScalingGroupName * The name of the Auto Scaling group for the instance. */ public void setAutoScalingGroupName(String autoScalingGroupName) { this.autoScalingGroupName = autoScalingGroupName; } /** ** The name of the Auto Scaling group for the instance. *
* * @return The name of the Auto Scaling group for the instance. */ public String getAutoScalingGroupName() { return this.autoScalingGroupName; } /** ** The name of the Auto Scaling group for the instance. *
* * @param autoScalingGroupName * The name of the Auto Scaling group for the instance. * @return Returns a reference to this object so that method calls can be chained together. */ public AutoScalingInstanceDetails withAutoScalingGroupName(String autoScalingGroupName) { setAutoScalingGroupName(autoScalingGroupName); return this; } /** ** The Availability Zone for the instance. *
* * @param availabilityZone * The Availability Zone for the instance. */ public void setAvailabilityZone(String availabilityZone) { this.availabilityZone = availabilityZone; } /** ** The Availability Zone for the instance. *
* * @return The Availability Zone for the instance. */ public String getAvailabilityZone() { return this.availabilityZone; } /** ** The Availability Zone for the instance. *
* * @param availabilityZone * The Availability Zone for the instance. * @return Returns a reference to this object so that method calls can be chained together. */ public AutoScalingInstanceDetails withAvailabilityZone(String availabilityZone) { setAvailabilityZone(availabilityZone); return this; } /** *
* The lifecycle state for the instance. The Quarantined
state is not used. For information about
* lifecycle states, see Instance
* lifecycle in the Amazon EC2 Auto Scaling User Guide.
*
* Valid values: Pending
| Pending:Wait
| Pending:Proceed
|
* Quarantined
| InService
| Terminating
| Terminating:Wait
|
* Terminating:Proceed
| Terminated
| Detaching
| Detached
|
* EnteringStandby
| Standby
| Warmed:Pending
|
* Warmed:Pending:Wait
| Warmed:Pending:Proceed
| Warmed:Terminating
|
* Warmed:Terminating:Wait
| Warmed:Terminating:Proceed
| Warmed:Terminated
|
* Warmed:Stopped
| Warmed:Running
*
Quarantined
state is not used. For information
* about lifecycle states, see Instance
* lifecycle in the Amazon EC2 Auto Scaling User Guide.
*
* Valid values: Pending
| Pending:Wait
| Pending:Proceed
|
* Quarantined
| InService
| Terminating
|
* Terminating:Wait
| Terminating:Proceed
| Terminated
|
* Detaching
| Detached
| EnteringStandby
| Standby
|
* Warmed:Pending
| Warmed:Pending:Wait
| Warmed:Pending:Proceed
|
* Warmed:Terminating
| Warmed:Terminating:Wait
|
* Warmed:Terminating:Proceed
| Warmed:Terminated
| Warmed:Stopped
|
* Warmed:Running
*/
public void setLifecycleState(String lifecycleState) {
this.lifecycleState = lifecycleState;
}
/**
*
* The lifecycle state for the instance. The Quarantined
state is not used. For information about
* lifecycle states, see Instance
* lifecycle in the Amazon EC2 Auto Scaling User Guide.
*
* Valid values: Pending
| Pending:Wait
| Pending:Proceed
|
* Quarantined
| InService
| Terminating
| Terminating:Wait
|
* Terminating:Proceed
| Terminated
| Detaching
| Detached
|
* EnteringStandby
| Standby
| Warmed:Pending
|
* Warmed:Pending:Wait
| Warmed:Pending:Proceed
| Warmed:Terminating
|
* Warmed:Terminating:Wait
| Warmed:Terminating:Proceed
| Warmed:Terminated
|
* Warmed:Stopped
| Warmed:Running
*
Quarantined
state is not used. For information
* about lifecycle states, see Instance
* lifecycle in the Amazon EC2 Auto Scaling User Guide.
*
* Valid values: Pending
| Pending:Wait
| Pending:Proceed
|
* Quarantined
| InService
| Terminating
|
* Terminating:Wait
| Terminating:Proceed
| Terminated
|
* Detaching
| Detached
| EnteringStandby
| Standby
|
* Warmed:Pending
| Warmed:Pending:Wait
| Warmed:Pending:Proceed
|
* Warmed:Terminating
| Warmed:Terminating:Wait
|
* Warmed:Terminating:Proceed
| Warmed:Terminated
| Warmed:Stopped
|
* Warmed:Running
*/
public String getLifecycleState() {
return this.lifecycleState;
}
/**
*
* The lifecycle state for the instance. The Quarantined
state is not used. For information about
* lifecycle states, see Instance
* lifecycle in the Amazon EC2 Auto Scaling User Guide.
*
* Valid values: Pending
| Pending:Wait
| Pending:Proceed
|
* Quarantined
| InService
| Terminating
| Terminating:Wait
|
* Terminating:Proceed
| Terminated
| Detaching
| Detached
|
* EnteringStandby
| Standby
| Warmed:Pending
|
* Warmed:Pending:Wait
| Warmed:Pending:Proceed
| Warmed:Terminating
|
* Warmed:Terminating:Wait
| Warmed:Terminating:Proceed
| Warmed:Terminated
|
* Warmed:Stopped
| Warmed:Running
*
Quarantined
state is not used. For information
* about lifecycle states, see Instance
* lifecycle in the Amazon EC2 Auto Scaling User Guide.
*
* Valid values: Pending
| Pending:Wait
| Pending:Proceed
|
* Quarantined
| InService
| Terminating
|
* Terminating:Wait
| Terminating:Proceed
| Terminated
|
* Detaching
| Detached
| EnteringStandby
| Standby
|
* Warmed:Pending
| Warmed:Pending:Wait
| Warmed:Pending:Proceed
|
* Warmed:Terminating
| Warmed:Terminating:Wait
|
* Warmed:Terminating:Proceed
| Warmed:Terminated
| Warmed:Stopped
|
* Warmed:Running
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AutoScalingInstanceDetails withLifecycleState(String lifecycleState) {
setLifecycleState(lifecycleState);
return this;
}
/**
*
* The last reported health status of this instance. Healthy
means that the instance is healthy and
* should remain in service. Unhealthy
means that the instance is unhealthy and Amazon EC2 Auto Scaling
* should terminate and replace it.
*
Healthy
means that the instance is healthy
* and should remain in service. Unhealthy
means that the instance is unhealthy and Amazon EC2
* Auto Scaling should terminate and replace it.
*/
public void setHealthStatus(String healthStatus) {
this.healthStatus = healthStatus;
}
/**
*
* The last reported health status of this instance. Healthy
means that the instance is healthy and
* should remain in service. Unhealthy
means that the instance is unhealthy and Amazon EC2 Auto Scaling
* should terminate and replace it.
*
Healthy
means that the instance is healthy
* and should remain in service. Unhealthy
means that the instance is unhealthy and Amazon EC2
* Auto Scaling should terminate and replace it.
*/
public String getHealthStatus() {
return this.healthStatus;
}
/**
*
* The last reported health status of this instance. Healthy
means that the instance is healthy and
* should remain in service. Unhealthy
means that the instance is unhealthy and Amazon EC2 Auto Scaling
* should terminate and replace it.
*
Healthy
means that the instance is healthy
* and should remain in service. Unhealthy
means that the instance is unhealthy and Amazon EC2
* Auto Scaling should terminate and replace it.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AutoScalingInstanceDetails withHealthStatus(String healthStatus) {
setHealthStatus(healthStatus);
return this;
}
/**
* * The launch configuration used to launch the instance. This value is not available if you attached the instance to * the Auto Scaling group. *
* * @param launchConfigurationName * The launch configuration used to launch the instance. This value is not available if you attached the * instance to the Auto Scaling group. */ public void setLaunchConfigurationName(String launchConfigurationName) { this.launchConfigurationName = launchConfigurationName; } /** ** The launch configuration used to launch the instance. This value is not available if you attached the instance to * the Auto Scaling group. *
* * @return The launch configuration used to launch the instance. This value is not available if you attached the * instance to the Auto Scaling group. */ public String getLaunchConfigurationName() { return this.launchConfigurationName; } /** ** The launch configuration used to launch the instance. This value is not available if you attached the instance to * the Auto Scaling group. *
* * @param launchConfigurationName * The launch configuration used to launch the instance. This value is not available if you attached the * instance to the Auto Scaling group. * @return Returns a reference to this object so that method calls can be chained together. */ public AutoScalingInstanceDetails withLaunchConfigurationName(String launchConfigurationName) { setLaunchConfigurationName(launchConfigurationName); return this; } /** ** The launch template for the instance. *
* * @param launchTemplate * The launch template for the instance. */ public void setLaunchTemplate(LaunchTemplateSpecification launchTemplate) { this.launchTemplate = launchTemplate; } /** ** The launch template for the instance. *
* * @return The launch template for the instance. */ public LaunchTemplateSpecification getLaunchTemplate() { return this.launchTemplate; } /** ** The launch template for the instance. *
* * @param launchTemplate * The launch template for the instance. * @return Returns a reference to this object so that method calls can be chained together. */ public AutoScalingInstanceDetails withLaunchTemplate(LaunchTemplateSpecification launchTemplate) { setLaunchTemplate(launchTemplate); return this; } /** ** Indicates whether the instance is protected from termination by Amazon EC2 Auto Scaling when scaling in. *
* * @param protectedFromScaleIn * Indicates whether the instance is protected from termination by Amazon EC2 Auto Scaling when scaling in. */ public void setProtectedFromScaleIn(Boolean protectedFromScaleIn) { this.protectedFromScaleIn = protectedFromScaleIn; } /** ** Indicates whether the instance is protected from termination by Amazon EC2 Auto Scaling when scaling in. *
* * @return Indicates whether the instance is protected from termination by Amazon EC2 Auto Scaling when scaling in. */ public Boolean getProtectedFromScaleIn() { return this.protectedFromScaleIn; } /** ** Indicates whether the instance is protected from termination by Amazon EC2 Auto Scaling when scaling in. *
* * @param protectedFromScaleIn * Indicates whether the instance is protected from termination by Amazon EC2 Auto Scaling when scaling in. * @return Returns a reference to this object so that method calls can be chained together. */ public AutoScalingInstanceDetails withProtectedFromScaleIn(Boolean protectedFromScaleIn) { setProtectedFromScaleIn(protectedFromScaleIn); return this; } /** ** Indicates whether the instance is protected from termination by Amazon EC2 Auto Scaling when scaling in. *
* * @return Indicates whether the instance is protected from termination by Amazon EC2 Auto Scaling when scaling in. */ public Boolean isProtectedFromScaleIn() { return this.protectedFromScaleIn; } /** ** The number of capacity units contributed by the instance based on its instance type. *
** Valid Range: Minimum value of 1. Maximum value of 999. *
* * @param weightedCapacity * The number of capacity units contributed by the instance based on its instance type. ** Valid Range: Minimum value of 1. Maximum value of 999. */ public void setWeightedCapacity(String weightedCapacity) { this.weightedCapacity = weightedCapacity; } /** *
* The number of capacity units contributed by the instance based on its instance type. *
** Valid Range: Minimum value of 1. Maximum value of 999. *
* * @return The number of capacity units contributed by the instance based on its instance type. ** Valid Range: Minimum value of 1. Maximum value of 999. */ public String getWeightedCapacity() { return this.weightedCapacity; } /** *
* The number of capacity units contributed by the instance based on its instance type. *
** Valid Range: Minimum value of 1. Maximum value of 999. *
* * @param weightedCapacity * The number of capacity units contributed by the instance based on its instance type. ** Valid Range: Minimum value of 1. Maximum value of 999. * @return Returns a reference to this object so that method calls can be chained together. */ public AutoScalingInstanceDetails withWeightedCapacity(String weightedCapacity) { setWeightedCapacity(weightedCapacity); 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 (getInstanceId() != null) sb.append("InstanceId: ").append(getInstanceId()).append(","); if (getInstanceType() != null) sb.append("InstanceType: ").append(getInstanceType()).append(","); if (getAutoScalingGroupName() != null) sb.append("AutoScalingGroupName: ").append(getAutoScalingGroupName()).append(","); if (getAvailabilityZone() != null) sb.append("AvailabilityZone: ").append(getAvailabilityZone()).append(","); if (getLifecycleState() != null) sb.append("LifecycleState: ").append(getLifecycleState()).append(","); if (getHealthStatus() != null) sb.append("HealthStatus: ").append(getHealthStatus()).append(","); if (getLaunchConfigurationName() != null) sb.append("LaunchConfigurationName: ").append(getLaunchConfigurationName()).append(","); if (getLaunchTemplate() != null) sb.append("LaunchTemplate: ").append(getLaunchTemplate()).append(","); if (getProtectedFromScaleIn() != null) sb.append("ProtectedFromScaleIn: ").append(getProtectedFromScaleIn()).append(","); if (getWeightedCapacity() != null) sb.append("WeightedCapacity: ").append(getWeightedCapacity()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof AutoScalingInstanceDetails == false) return false; AutoScalingInstanceDetails other = (AutoScalingInstanceDetails) obj; if (other.getInstanceId() == null ^ this.getInstanceId() == null) return false; if (other.getInstanceId() != null && other.getInstanceId().equals(this.getInstanceId()) == false) return false; if (other.getInstanceType() == null ^ this.getInstanceType() == null) return false; if (other.getInstanceType() != null && other.getInstanceType().equals(this.getInstanceType()) == false) return false; if (other.getAutoScalingGroupName() == null ^ this.getAutoScalingGroupName() == null) return false; if (other.getAutoScalingGroupName() != null && other.getAutoScalingGroupName().equals(this.getAutoScalingGroupName()) == false) return false; if (other.getAvailabilityZone() == null ^ this.getAvailabilityZone() == null) return false; if (other.getAvailabilityZone() != null && other.getAvailabilityZone().equals(this.getAvailabilityZone()) == false) return false; if (other.getLifecycleState() == null ^ this.getLifecycleState() == null) return false; if (other.getLifecycleState() != null && other.getLifecycleState().equals(this.getLifecycleState()) == false) return false; if (other.getHealthStatus() == null ^ this.getHealthStatus() == null) return false; if (other.getHealthStatus() != null && other.getHealthStatus().equals(this.getHealthStatus()) == false) return false; if (other.getLaunchConfigurationName() == null ^ this.getLaunchConfigurationName() == null) return false; if (other.getLaunchConfigurationName() != null && other.getLaunchConfigurationName().equals(this.getLaunchConfigurationName()) == false) return false; if (other.getLaunchTemplate() == null ^ this.getLaunchTemplate() == null) return false; if (other.getLaunchTemplate() != null && other.getLaunchTemplate().equals(this.getLaunchTemplate()) == false) return false; if (other.getProtectedFromScaleIn() == null ^ this.getProtectedFromScaleIn() == null) return false; if (other.getProtectedFromScaleIn() != null && other.getProtectedFromScaleIn().equals(this.getProtectedFromScaleIn()) == false) return false; if (other.getWeightedCapacity() == null ^ this.getWeightedCapacity() == null) return false; if (other.getWeightedCapacity() != null && other.getWeightedCapacity().equals(this.getWeightedCapacity()) == false) return false; return true; } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getInstanceId() == null) ? 0 : getInstanceId().hashCode()); hashCode = prime * hashCode + ((getInstanceType() == null) ? 0 : getInstanceType().hashCode()); hashCode = prime * hashCode + ((getAutoScalingGroupName() == null) ? 0 : getAutoScalingGroupName().hashCode()); hashCode = prime * hashCode + ((getAvailabilityZone() == null) ? 0 : getAvailabilityZone().hashCode()); hashCode = prime * hashCode + ((getLifecycleState() == null) ? 0 : getLifecycleState().hashCode()); hashCode = prime * hashCode + ((getHealthStatus() == null) ? 0 : getHealthStatus().hashCode()); hashCode = prime * hashCode + ((getLaunchConfigurationName() == null) ? 0 : getLaunchConfigurationName().hashCode()); hashCode = prime * hashCode + ((getLaunchTemplate() == null) ? 0 : getLaunchTemplate().hashCode()); hashCode = prime * hashCode + ((getProtectedFromScaleIn() == null) ? 0 : getProtectedFromScaleIn().hashCode()); hashCode = prime * hashCode + ((getWeightedCapacity() == null) ? 0 : getWeightedCapacity().hashCode()); return hashCode; } @Override public AutoScalingInstanceDetails clone() { try { return (AutoScalingInstanceDetails) super.clone(); } catch (CloneNotSupportedException e) { throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e); } } }