software.amazon.awssdk.services.autoscaling.model

Class Instance

java.lang.Object

software.amazon.awssdk.services.autoscaling.model.Instance

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Instance.Builder,Instance>

@Generated(value="software.amazon.awssdk:codegen")
public final class Instance
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Instance.Builder,Instance>

Describes an EC2 instance.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Instance.Builder

Method Summary

Modifier and Type	Method and Description
String	availabilityZone() The Availability Zone in which the instance is running.
static Instance.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	healthStatus() The last reported health status of the instance.
String	instanceId() The ID of the instance.
String	instanceType() The instance type of the EC2 instance.
String	launchConfigurationName() The launch configuration associated with the instance.
LaunchTemplateSpecification	launchTemplate() The launch template for the instance.
LifecycleState	lifecycleState() A description of the current lifecycle state.
String	lifecycleStateAsString() A description of the current lifecycle state.
Boolean	protectedFromScaleIn() Indicates whether the instance is protected from termination by Amazon EC2 Auto Scaling when scaling in.
List<SdkField<?>>	sdkFields()
static Class<? extends Instance.Builder>	serializableBuilderClass()
Instance.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	weightedCapacity() 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.

availabilityZone

public final String availabilityZone()

The Availability Zone in which the instance is running.

Returns:

The Availability Zone in which the instance is running.

lifecycleState

public final LifecycleState lifecycleState()

A description of the current lifecycle state. The Quarantined state is not used. For information about lifecycle states, see Instance lifecycle in the Amazon EC2 Auto Scaling User Guide.

If the service returns an enum value that is not available in the current SDK version, lifecycleState will return LifecycleState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from lifecycleStateAsString().

Returns:

A description of the current lifecycle state. The Quarantined state is not used. For information about lifecycle states, see Instance lifecycle in the Amazon EC2 Auto Scaling User Guide.

See Also:

LifecycleState

lifecycleStateAsString

public final String lifecycleStateAsString()

A description of the current lifecycle state. The Quarantined state is not used. For information about lifecycle states, see Instance lifecycle in the Amazon EC2 Auto Scaling User Guide.

If the service returns an enum value that is not available in the current SDK version, lifecycleState will return LifecycleState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from lifecycleStateAsString().

Returns:

A description of the current lifecycle state. The Quarantined state is not used. For information about lifecycle states, see Instance lifecycle in the Amazon EC2 Auto Scaling User Guide.

See Also:

LifecycleState

healthStatus

public final String healthStatus()

The last reported health status of the instance. Healthy means that the instance is healthy and should remain in service. Unhealthy means that the instance is unhealthy and that Amazon EC2 Auto Scaling should terminate and replace it.

Returns:

The last reported health status of the instance. Healthy means that the instance is healthy and should remain in service. Unhealthy means that the instance is unhealthy and that Amazon EC2 Auto Scaling should terminate and replace it.

launchConfigurationName

public final String launchConfigurationName()

The launch configuration associated with the instance.

Returns:

The launch configuration associated with the instance.

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 Instance.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Instance.Builder,Instance>

builder

public static Instance.Builder builder()

serializableBuilderClass

public static Class<? extends Instance.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo