software.amazon.awssdk.services.lightsail.model

Interface InstanceHealthSummary.Builder

All Superinterfaces:

Buildable, CopyableBuilder<InstanceHealthSummary.Builder,InstanceHealthSummary>, SdkBuilder<InstanceHealthSummary.Builder,InstanceHealthSummary>, SdkPojo

Enclosing class:

InstanceHealthSummary

public static interface InstanceHealthSummary.Builder
extends SdkPojo, CopyableBuilder<InstanceHealthSummary.Builder,InstanceHealthSummary>

Method Summary

Modifier and Type	Method and Description
InstanceHealthSummary.Builder	instanceHealth(InstanceHealthState instanceHealth) Describes the overall instance health.
InstanceHealthSummary.Builder	instanceHealth(String instanceHealth) Describes the overall instance health.
InstanceHealthSummary.Builder	instanceHealthReason(InstanceHealthReason instanceHealthReason) More information about the instance health.
InstanceHealthSummary.Builder	instanceHealthReason(String instanceHealthReason) More information about the instance health.
InstanceHealthSummary.Builder	instanceName(String instanceName) The name of the Lightsail instance for which you are requesting health check data.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

instanceName

InstanceHealthSummary.Builder instanceName(String instanceName)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

instanceHealth

InstanceHealthSummary.Builder instanceHealth(String instanceHealth)

Describes the overall instance health. Valid values are below.

Parameters:

instanceHealth - Describes the overall instance health. Valid values are below.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

InstanceHealthState, InstanceHealthState

instanceHealth

InstanceHealthSummary.Builder instanceHealth(InstanceHealthState instanceHealth)

Describes the overall instance health. Valid values are below.

Parameters:

instanceHealth - Describes the overall instance health. Valid values are below.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

InstanceHealthState, InstanceHealthState

instanceHealthReason

InstanceHealthSummary.Builder instanceHealthReason(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

InstanceHealthReason, InstanceHealthReason

instanceHealthReason

InstanceHealthSummary.Builder instanceHealthReason(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

InstanceHealthReason, InstanceHealthReason