Struct HealthCheckConfiguration

#[non_exhaustive]
pub struct HealthCheckConfiguration {
    pub protocol: Option<HealthCheckProtocol>,
    pub path: Option<String>,
    pub interval: Option<i32>,
    pub timeout: Option<i32>,
    pub healthy_threshold: Option<i32>,
    pub unhealthy_threshold: Option<i32>,
}

Describes the settings for the health check that App Runner performs to monitor the health of a service.

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.

protocol: Option<HealthCheckProtocol>

The IP protocol that App Runner uses to perform health checks for your service.

If you set Protocol to HTTP, App Runner sends health check requests to the HTTP path specified by Path.

Default: TCP

path: Option<String>

The URL that health check requests are sent to.

Path is only applicable when you set Protocol to HTTP.

Default: "/"

interval: Option<i32>

The time interval, in seconds, between health checks.

Default: 5

timeout: Option<i32>

The time, in seconds, to wait for a health check response before deciding it failed.

Default: 2

healthy_threshold: Option<i32>

The number of consecutive checks that must succeed before App Runner decides that the service is healthy.

Default: 1

unhealthy_threshold: Option<i32>

The number of consecutive checks that must fail before App Runner decides that the service is unhealthy.

Default: 5

Implementations

impl HealthCheckConfiguration

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

The IP protocol that App Runner uses to perform health checks for your service.

If you set Protocol to HTTP, App Runner sends health check requests to the HTTP path specified by Path.

Default: TCP

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

The URL that health check requests are sent to.

Path is only applicable when you set Protocol to HTTP.

Default: "/"

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

The time interval, in seconds, between health checks.

Default: 5

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

The time, in seconds, to wait for a health check response before deciding it failed.

Default: 2

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

The number of consecutive checks that must succeed before App Runner decides that the service is healthy.

Default: 1

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

The number of consecutive checks that must fail before App Runner decides that the service is unhealthy.

Default: 5

impl HealthCheckConfiguration

pub fn builder() -> HealthCheckConfigurationBuilder

Creates a new builder-style object to manufacture HealthCheckConfiguration.

Trait Implementations

impl Clone for HealthCheckConfiguration

fn clone(&self) -> HealthCheckConfiguration

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HealthCheckConfiguration

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

Formats the value using the given formatter.

impl PartialEq for HealthCheckConfiguration

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

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

const 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 HealthCheckConfiguration