Class InstanceHealthSummary

java.lang.Object
software.amazon.awssdk.services.lightsail.model.InstanceHealthSummary
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<InstanceHealthSummary.Builder,InstanceHealthSummary>
@Generated("software.amazon.awssdk:codegen") public final class InstanceHealthSummary extends Object implements SdkPojo, Serializable, ToCopyableBuilder<InstanceHealthSummary.Builder,InstanceHealthSummary>

Describes information about the health of the instance.

See Also:

  • Method Details

    • instanceName

      public final String instanceName()

      The name of the Lightsail instance for which you are requesting health check data.

      Returns:
      The name of the Lightsail instance for which you are requesting health check data.

    • instanceHealth

      public final InstanceHealthState instanceHealth()

      Describes the overall instance health. Valid values are below.

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

      Returns:
      Describes the overall instance health. Valid values are below.
      See Also:

    • instanceHealthAsString

      public final String instanceHealthAsString()

      Describes the overall instance health. Valid values are below.

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

      Returns:
      Describes the overall instance health. Valid values are below.
      See Also:

    • instanceHealthReason

      public final InstanceHealthReason instanceHealthReason()

      More information about the instance health. If the instanceHealth is healthy, then an instanceHealthReason value is not provided.

      If instanceHealth is initial, the instanceHealthReason value can be one of the following:

      • Lb.RegistrationInProgress - The target instance is in the process of being registered with the load balancer.

      • Lb.InitialHealthChecking - The Lightsail load balancer is still sending the target instance the minimum number of health checks required to determine its health status.

      If instanceHealth is unhealthy, the instanceHealthReason value can be one of the following:

      • Instance.ResponseCodeMismatch - The health checks did not return an expected HTTP code.

      • Instance.Timeout - The health check requests timed out.

      • Instance.FailedHealthChecks - The health checks failed because the connection to the target instance timed out, the target instance response was malformed, or the target instance failed the health check for an unknown reason.

      • Lb.InternalError - The health checks failed due to an internal error.

      If instanceHealth is unused, the instanceHealthReason value can be one of the following:

      • Instance.NotRegistered - The target instance is not registered with the target group.

      • Instance.NotInUse - The target group is not used by any load balancer, or the target instance is in an Availability Zone that is not enabled for its load balancer.

      • Instance.IpUnusable - The target IP address is reserved for use by a Lightsail load balancer.

      • Instance.InvalidState - The target is in the stopped or terminated state.

      If instanceHealth is draining, the instanceHealthReason value can be one of the following:

      • Instance.DeregistrationInProgress - The target instance is in the process of being deregistered and the deregistration delay period has not expired.

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

      Returns:
      More information about the instance health. If the instanceHealth is healthy, then an instanceHealthReason value is not provided.

      If instanceHealth is initial, the instanceHealthReason value can be one of the following:

      • Lb.RegistrationInProgress - The target instance is in the process of being registered with the load balancer.

      • Lb.InitialHealthChecking - The Lightsail load balancer is still sending the target instance the minimum number of health checks required to determine its health status.

      If instanceHealth is unhealthy, the instanceHealthReason value can be one of the following:

      • Instance.ResponseCodeMismatch - The health checks did not return an expected HTTP code.

      • Instance.Timeout - The health check requests timed out.

      • Instance.FailedHealthChecks - The health checks failed because the connection to the target instance timed out, the target instance response was malformed, or the target instance failed the health check for an unknown reason.

      • Lb.InternalError - The health checks failed due to an internal error.

      If instanceHealth is unused, the instanceHealthReason value can be one of the following:

      • Instance.NotRegistered - The target instance is not registered with the target group.

      • Instance.NotInUse - The target group is not used by any load balancer, or the target instance is in an Availability Zone that is not enabled for its load balancer.

      • Instance.IpUnusable - The target IP address is reserved for use by a Lightsail load balancer.

      • Instance.InvalidState - The target is in the stopped or terminated state.

      If instanceHealth is draining, the instanceHealthReason value can be one of the following:

      • Instance.DeregistrationInProgress - The target instance is in the process of being deregistered and the deregistration delay period has not expired.

      See Also:

    • instanceHealthReasonAsString

      public final String instanceHealthReasonAsString()

      More information about the instance health. If the instanceHealth is healthy, then an instanceHealthReason value is not provided.

      If instanceHealth is initial, the instanceHealthReason value can be one of the following:

      • Lb.RegistrationInProgress - The target instance is in the process of being registered with the load balancer.

      • Lb.InitialHealthChecking - The Lightsail load balancer is still sending the target instance the minimum number of health checks required to determine its health status.

      If instanceHealth is unhealthy, the instanceHealthReason value can be one of the following:

      • Instance.ResponseCodeMismatch - The health checks did not return an expected HTTP code.

      • Instance.Timeout - The health check requests timed out.

      • Instance.FailedHealthChecks - The health checks failed because the connection to the target instance timed out, the target instance response was malformed, or the target instance failed the health check for an unknown reason.

      • Lb.InternalError - The health checks failed due to an internal error.

      If instanceHealth is unused, the instanceHealthReason value can be one of the following:

      • Instance.NotRegistered - The target instance is not registered with the target group.

      • Instance.NotInUse - The target group is not used by any load balancer, or the target instance is in an Availability Zone that is not enabled for its load balancer.

      • Instance.IpUnusable - The target IP address is reserved for use by a Lightsail load balancer.

      • Instance.InvalidState - The target is in the stopped or terminated state.

      If instanceHealth is draining, the instanceHealthReason value can be one of the following:

      • Instance.DeregistrationInProgress - The target instance is in the process of being deregistered and the deregistration delay period has not expired.

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

      Returns:
      More information about the instance health. If the instanceHealth is healthy, then an instanceHealthReason value is not provided.

      If instanceHealth is initial, the instanceHealthReason value can be one of the following:

      • Lb.RegistrationInProgress - The target instance is in the process of being registered with the load balancer.

      • Lb.InitialHealthChecking - The Lightsail load balancer is still sending the target instance the minimum number of health checks required to determine its health status.

      If instanceHealth is unhealthy, the instanceHealthReason value can be one of the following:

      • Instance.ResponseCodeMismatch - The health checks did not return an expected HTTP code.

      • Instance.Timeout - The health check requests timed out.

      • Instance.FailedHealthChecks - The health checks failed because the connection to the target instance timed out, the target instance response was malformed, or the target instance failed the health check for an unknown reason.

      • Lb.InternalError - The health checks failed due to an internal error.

      If instanceHealth is unused, the instanceHealthReason value can be one of the following:

      • Instance.NotRegistered - The target instance is not registered with the target group.

      • Instance.NotInUse - The target group is not used by any load balancer, or the target instance is in an Availability Zone that is not enabled for its load balancer.

      • Instance.IpUnusable - The target IP address is reserved for use by a Lightsail load balancer.

      • Instance.InvalidState - The target is in the stopped or terminated state.

      If instanceHealth is draining, the instanceHealthReason value can be one of the following:

      • Instance.DeregistrationInProgress - The target instance is in the process of being deregistered and the deregistration delay period has not expired.

      See Also:

    • toBuilder

      public InstanceHealthSummary.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<InstanceHealthSummary.Builder,InstanceHealthSummary>
      Returns:
      a builder for type T

    • builder

      public static InstanceHealthSummary.Builder builder()

    • serializableBuilderClass

      public static Class<? extends InstanceHealthSummary.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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.