Struct aws_sdk_lightsail::model::InstanceHealthSummary

#[non_exhaustive]
pub struct InstanceHealthSummary {
    pub instance_name: Option<String>,
    pub instance_health: Option<InstanceHealthState>,
    pub instance_health_reason: Option<InstanceHealthReason>,
}

Describes information about the health of the instance.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

instance_name: Option<String>

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

instance_health: Option<InstanceHealthState>

Describes the overall instance health. Valid values are below.

instance_health_reason: Option<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.

Implementations

impl InstanceHealthSummary

pub fn instance_name(&self) -> Option<&str>

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

pub fn instance_health(&self) -> Option<&InstanceHealthState>

Describes the overall instance health. Valid values are below.

pub fn instance_health_reason(&self) -> Option<&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.

impl InstanceHealthSummary

pub fn builder() -> Builder

Creates a new builder-style object to manufacture InstanceHealthSummary

Trait Implementations

impl Clone for InstanceHealthSummary

fn clone(&self) -> InstanceHealthSummary

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for InstanceHealthSummary

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq<InstanceHealthSummary> for InstanceHealthSummary

fn eq(&self, other: &InstanceHealthSummary) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &InstanceHealthSummary) -> bool

This method tests for !=.

impl StructuralPartialEq for InstanceHealthSummary