Struct aws_sdk_lightsail::types::builders::InstanceHealthSummaryBuilder

#[non_exhaustive]
pub struct InstanceHealthSummaryBuilder { /* private fields */ }

A builder for InstanceHealthSummary.

Implementations

impl InstanceHealthSummaryBuilder

pub fn instance_name(self, input: impl Into<String>) -> Self

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

pub fn set_instance_name(self, input: Option<String>) -> Self

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

pub fn get_instance_name(&self) -> &Option<String>

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

pub fn instance_health(self, input: InstanceHealthState) -> Self

Describes the overall instance health. Valid values are below.

pub fn set_instance_health(self, input: Option<InstanceHealthState>) -> Self

Describes the overall instance health. Valid values are below.

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

Describes the overall instance health. Valid values are below.

pub fn instance_health_reason(self, input: InstanceHealthReason) -> Self

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.

pub fn set_instance_health_reason( self, input: Option<InstanceHealthReason> ) -> Self

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.

pub fn get_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.

pub fn build(self) -> InstanceHealthSummary

Consumes the builder and constructs a InstanceHealthSummary.

Trait Implementations

impl Clone for InstanceHealthSummaryBuilder

fn clone(&self) -> InstanceHealthSummaryBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for InstanceHealthSummaryBuilder

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

Formats the value using the given formatter.

impl Default for InstanceHealthSummaryBuilder

fn default() -> InstanceHealthSummaryBuilder

Returns the “default value” for a type.

impl PartialEq for InstanceHealthSummaryBuilder

fn eq(&self, other: &InstanceHealthSummaryBuilder) -> 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 InstanceHealthSummaryBuilder