Class InstanceHealthSummary
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<InstanceHealthSummary.Builder,
InstanceHealthSummary>
Describes information about the health of the instance.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final InstanceHealthState
Describes the overall instance health.final String
Describes the overall instance health.final InstanceHealthReason
More information about the instance health.final String
More information about the instance health.final String
The name of the Lightsail instance for which you are requesting health check data.static Class
<? extends InstanceHealthSummary.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
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 returnInstanceHealthState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frominstanceHealthAsString()
.- Returns:
- Describes the overall instance health. Valid values are below.
- See Also:
-
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 returnInstanceHealthState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frominstanceHealthAsString()
.- Returns:
- Describes the overall instance health. Valid values are below.
- See Also:
-
instanceHealthReason
More information about the instance health. If the
instanceHealth
ishealthy
, then aninstanceHealthReason
value is not provided.If
instanceHealth
isinitial
, theinstanceHealthReason
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
isunhealthy
, theinstanceHealthReason
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
isunused
, theinstanceHealthReason
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
isdraining
, theinstanceHealthReason
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 returnInstanceHealthReason.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frominstanceHealthReasonAsString()
.- Returns:
- More information about the instance health. If the
instanceHealth
ishealthy
, then aninstanceHealthReason
value is not provided.If
instanceHealth
isinitial
, theinstanceHealthReason
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
isunhealthy
, theinstanceHealthReason
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
isunused
, theinstanceHealthReason
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
isdraining
, theinstanceHealthReason
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
More information about the instance health. If the
instanceHealth
ishealthy
, then aninstanceHealthReason
value is not provided.If
instanceHealth
isinitial
, theinstanceHealthReason
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
isunhealthy
, theinstanceHealthReason
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
isunused
, theinstanceHealthReason
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
isdraining
, theinstanceHealthReason
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 returnInstanceHealthReason.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frominstanceHealthReasonAsString()
.- Returns:
- More information about the instance health. If the
instanceHealth
ishealthy
, then aninstanceHealthReason
value is not provided.If
instanceHealth
isinitial
, theinstanceHealthReason
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
isunhealthy
, theinstanceHealthReason
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
isunused
, theinstanceHealthReason
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
isdraining
, theinstanceHealthReason
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
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 interfaceToCopyableBuilder<InstanceHealthSummary.Builder,
InstanceHealthSummary> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-