Struct aws_sdk_elasticloadbalancingv2::types::TargetHealth

#[non_exhaustive]
pub struct TargetHealth {
    pub state: Option<TargetHealthStateEnum>,
    pub reason: Option<TargetHealthReasonEnum>,
    pub description: Option<String>,
}

Information about the current health of a target.

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.

state: Option<TargetHealthStateEnum>

The state of the target.

reason: Option<TargetHealthReasonEnum>

The reason code.

If the target state is healthy, a reason code is not provided.

If the target state is initial, the reason code can be one of the following values:

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

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

If the target state is unhealthy, the reason code can be one of the following values:

• Target.ResponseCodeMismatch - The health checks did not return an expected HTTP code. Applies only to Application Load Balancers and Gateway Load Balancers.

• Target.Timeout - The health check requests timed out. Applies only to Application Load Balancers and Gateway Load Balancers.

• Target.FailedHealthChecks - The load balancer received an error while establishing a connection to the target or the target response was malformed.

• Elb.InternalError - The health checks failed due to an internal error. Applies only to Application Load Balancers.

If the target state is unused, the reason code can be one of the following values:

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

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

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

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

If the target state is draining, the reason code can be the following value:

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

If the target state is unavailable, the reason code can be the following value:

• Target.HealthCheckDisabled - Health checks are disabled for the target group. Applies only to Application Load Balancers.

• Elb.InternalError - Target health is unavailable due to an internal error. Applies only to Network Load Balancers.

description: Option<String>

A description of the target health that provides additional details. If the state is healthy, a description is not provided.

Implementations

impl TargetHealth

pub fn state(&self) -> Option<&TargetHealthStateEnum>

The state of the target.

pub fn reason(&self) -> Option<&TargetHealthReasonEnum>

The reason code.

If the target state is healthy, a reason code is not provided.

If the target state is initial, the reason code can be one of the following values:

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

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

If the target state is unhealthy, the reason code can be one of the following values:

• Target.ResponseCodeMismatch - The health checks did not return an expected HTTP code. Applies only to Application Load Balancers and Gateway Load Balancers.

• Target.Timeout - The health check requests timed out. Applies only to Application Load Balancers and Gateway Load Balancers.

• Target.FailedHealthChecks - The load balancer received an error while establishing a connection to the target or the target response was malformed.

• Elb.InternalError - The health checks failed due to an internal error. Applies only to Application Load Balancers.

If the target state is unused, the reason code can be one of the following values:

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

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

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

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

If the target state is draining, the reason code can be the following value:

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

If the target state is unavailable, the reason code can be the following value:

• Target.HealthCheckDisabled - Health checks are disabled for the target group. Applies only to Application Load Balancers.

• Elb.InternalError - Target health is unavailable due to an internal error. Applies only to Network Load Balancers.

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

A description of the target health that provides additional details. If the state is healthy, a description is not provided.

impl TargetHealth

pub fn builder() -> TargetHealthBuilder

Creates a new builder-style object to manufacture TargetHealth.

Trait Implementations

impl Clone for TargetHealth

fn clone(&self) -> TargetHealth

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TargetHealth

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

Formats the value using the given formatter.

impl PartialEq for TargetHealth

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for TargetHealth