Class AutoScalingInstanceDetails
- java.lang.Object
-
- software.amazon.awssdk.services.autoscaling.model.AutoScalingInstanceDetails
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<AutoScalingInstanceDetails.Builder,AutoScalingInstanceDetails>
@Generated("software.amazon.awssdk:codegen") public final class AutoScalingInstanceDetails extends Object implements SdkPojo, Serializable, ToCopyableBuilder<AutoScalingInstanceDetails.Builder,AutoScalingInstanceDetails>
Describes an EC2 instance associated with an Auto Scaling group.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceAutoScalingInstanceDetails.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description StringautoScalingGroupName()The name of the Auto Scaling group for the instance.StringavailabilityZone()The Availability Zone for the instance.static AutoScalingInstanceDetails.Builderbuilder()booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()StringhealthStatus()The last reported health status of this instance.StringinstanceId()The ID of the instance.StringinstanceType()The instance type of the EC2 instance.StringlaunchConfigurationName()The launch configuration used to launch the instance.LaunchTemplateSpecificationlaunchTemplate()The launch template for the instance.StringlifecycleState()The lifecycle state for the instance.BooleanprotectedFromScaleIn()Indicates whether the instance is protected from termination by Amazon EC2 Auto Scaling when scaling in.List<SdkField<?>>sdkFields()static Class<? extends AutoScalingInstanceDetails.Builder>serializableBuilderClass()AutoScalingInstanceDetails.BuildertoBuilder()StringtoString()Returns a string representation of this object.StringweightedCapacity()The number of capacity units contributed by the instance based on its instance type.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
instanceId
public final String instanceId()
The ID of the instance.
- Returns:
- The ID of the instance.
-
instanceType
public final String instanceType()
The instance type of the EC2 instance.
- Returns:
- The instance type of the EC2 instance.
-
autoScalingGroupName
public final String autoScalingGroupName()
The name of the Auto Scaling group for the instance.
- Returns:
- The name of the Auto Scaling group for the instance.
-
availabilityZone
public final String availabilityZone()
The Availability Zone for the instance.
- Returns:
- The Availability Zone for the instance.
-
lifecycleState
public final String lifecycleState()
The lifecycle state for the instance. The
Quarantinedstate 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- Returns:
- The lifecycle state for the instance. The
Quarantinedstate 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
-
healthStatus
public final String healthStatus()
The last reported health status of this instance.
Healthymeans that the instance is healthy and should remain in service.Unhealthymeans that the instance is unhealthy and Amazon EC2 Auto Scaling should terminate and replace it.- Returns:
- The last reported health status of this instance.
Healthymeans that the instance is healthy and should remain in service.Unhealthymeans that the instance is unhealthy and Amazon EC2 Auto Scaling should terminate and replace it.
-
launchConfigurationName
public final String launchConfigurationName()
The launch configuration used to launch the instance. This value is not available if you attached the instance to the Auto Scaling group.
- Returns:
- The launch configuration used to launch the instance. This value is not available if you attached the instance to the Auto Scaling group.
-
launchTemplate
public final LaunchTemplateSpecification launchTemplate()
The launch template for the instance.
- Returns:
- The launch template for the instance.
-
protectedFromScaleIn
public final Boolean protectedFromScaleIn()
Indicates whether the instance is protected from termination by Amazon EC2 Auto Scaling when scaling in.
- Returns:
- Indicates whether the instance is protected from termination by Amazon EC2 Auto Scaling when scaling in.
-
weightedCapacity
public final String 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.
- Returns:
- The number of capacity units contributed by the instance based on its instance type.
Valid Range: Minimum value of 1. Maximum value of 999.
-
toBuilder
public AutoScalingInstanceDetails.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<AutoScalingInstanceDetails.Builder,AutoScalingInstanceDetails>
-
builder
public static AutoScalingInstanceDetails.Builder builder()
-
serializableBuilderClass
public static Class<? extends AutoScalingInstanceDetails.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
toString
public final 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.
-
-