Struct HealthCheckConfig

#[non_exhaustive]
pub struct HealthCheckConfig {
    pub enabled: Option<bool>,
    pub protocol: Option<TargetGroupProtocol>,
    pub protocol_version: Option<HealthCheckProtocolVersion>,
    pub port: Option<i32>,
    pub path: Option<String>,
    pub health_check_interval_seconds: Option<i32>,
    pub health_check_timeout_seconds: Option<i32>,
    pub healthy_threshold_count: Option<i32>,
    pub unhealthy_threshold_count: Option<i32>,
    pub matcher: Option<Matcher>,
}

Describes the health check configuration of a target group. Health check configurations aren't used for target groups of type LAMBDA or ALB.

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.

enabled: Option<bool>

Indicates whether health checking is enabled.

protocol: Option<TargetGroupProtocol>

The protocol used when performing health checks on targets. The possible protocols are HTTP and HTTPS. The default is HTTP.

protocol_version: Option<HealthCheckProtocolVersion>

The protocol version used when performing health checks on targets. The possible protocol versions are HTTP1 and HTTP2.

port: Option<i32>

The port used when performing health checks on targets. The default setting is the port that a target receives traffic on.

path: Option<String>

The destination for health checks on the targets. If the protocol version is HTTP/1.1 or HTTP/2, specify a valid URI (for example, /path?query). The default path is /. Health checks are not supported if the protocol version is gRPC, however, you can choose HTTP/1.1 or HTTP/2 and specify a valid URI.

health_check_interval_seconds: Option<i32>

The approximate amount of time, in seconds, between health checks of an individual target. The range is 5–300 seconds. The default is 30 seconds.

health_check_timeout_seconds: Option<i32>

The amount of time, in seconds, to wait before reporting a target as unhealthy. The range is 1–120 seconds. The default is 5 seconds.

healthy_threshold_count: Option<i32>

The number of consecutive successful health checks required before considering an unhealthy target healthy. The range is 2–10. The default is 5.

unhealthy_threshold_count: Option<i32>

The number of consecutive failed health checks required before considering a target unhealthy. The range is 2–10. The default is 2.

matcher: Option<Matcher>

The codes to use when checking for a successful response from a target.

Implementations

impl HealthCheckConfig

pub fn enabled(&self) -> Option<bool>

Indicates whether health checking is enabled.

pub fn protocol(&self) -> Option<&TargetGroupProtocol>

The protocol used when performing health checks on targets. The possible protocols are HTTP and HTTPS. The default is HTTP.

pub fn protocol_version(&self) -> Option<&HealthCheckProtocolVersion>

The protocol version used when performing health checks on targets. The possible protocol versions are HTTP1 and HTTP2.

pub fn port(&self) -> Option<i32>

The port used when performing health checks on targets. The default setting is the port that a target receives traffic on.

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

The destination for health checks on the targets. If the protocol version is HTTP/1.1 or HTTP/2, specify a valid URI (for example, /path?query). The default path is /. Health checks are not supported if the protocol version is gRPC, however, you can choose HTTP/1.1 or HTTP/2 and specify a valid URI.

pub fn health_check_interval_seconds(&self) -> Option<i32>

The approximate amount of time, in seconds, between health checks of an individual target. The range is 5–300 seconds. The default is 30 seconds.

pub fn health_check_timeout_seconds(&self) -> Option<i32>

The amount of time, in seconds, to wait before reporting a target as unhealthy. The range is 1–120 seconds. The default is 5 seconds.

pub fn healthy_threshold_count(&self) -> Option<i32>

The number of consecutive successful health checks required before considering an unhealthy target healthy. The range is 2–10. The default is 5.

pub fn unhealthy_threshold_count(&self) -> Option<i32>

The number of consecutive failed health checks required before considering a target unhealthy. The range is 2–10. The default is 2.

pub fn matcher(&self) -> Option<&Matcher>

The codes to use when checking for a successful response from a target.

impl HealthCheckConfig

pub fn builder() -> HealthCheckConfigBuilder

Creates a new builder-style object to manufacture HealthCheckConfig.

Trait Implementations

impl Clone for HealthCheckConfig

fn clone(&self) -> HealthCheckConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for HealthCheckConfig

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

Formats the value using the given formatter.

impl PartialEq for HealthCheckConfig

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for HealthCheckConfig