Struct aws_sdk_gamelift::types::ContainerHealthCheck

#[non_exhaustive]
pub struct ContainerHealthCheck {
    pub command: Option<Vec<String>>,
    pub interval: Option<i32>,
    pub timeout: Option<i32>,
    pub retries: Option<i32>,
    pub start_period: Option<i32>,
}

Instructions on when and how to check the health of a container in a container fleet. When health check properties are set in a container definition, they override any Docker health checks in the container image. For more information on container health checks, see HealthCheck command in the Amazon Elastic Container Service API.

The following example instructions tell the container to wait 100 seconds after launch before counting failed health checks, then initiate the health check command every 60 seconds. After issuing the health check command, wait 10 seconds for it to succeed. If it fails, retry the command 3 times before considering the container to be unhealthy.

{"Command": [ "CMD-SHELL", "ps cax | grep "processmanager" || exit 1" ], "Interval": 300, "Timeout": 30, "Retries": 5, "StartPeriod": 100 }

Part of: ContainerDefinition$HealthCheck

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.

command: Option<Vec<String>>

A string array that specifies the command that the container runs to determine if it's healthy.

interval: Option<i32>

The time period (in seconds) between each health check.

timeout: Option<i32>

The time period (in seconds) to wait for a health check to succeed before a failed health check is counted.

retries: Option<i32>

The number of times to retry a failed health check before the container is considered unhealthy. The first run of the command does not count as a retry.

start_period: Option<i32>

The optional grace period (in seconds) to give a container time to bootstrap before the first failed health check counts toward the number of retries.

Implementations

impl ContainerHealthCheck

pub fn command(&self) -> &[String]

A string array that specifies the command that the container runs to determine if it's healthy.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .command.is_none().

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

The time period (in seconds) between each health check.

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

The time period (in seconds) to wait for a health check to succeed before a failed health check is counted.

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

The number of times to retry a failed health check before the container is considered unhealthy. The first run of the command does not count as a retry.

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

The optional grace period (in seconds) to give a container time to bootstrap before the first failed health check counts toward the number of retries.

impl ContainerHealthCheck

pub fn builder() -> ContainerHealthCheckBuilder

Creates a new builder-style object to manufacture ContainerHealthCheck.

Trait Implementations

impl Clone for ContainerHealthCheck

fn clone(&self) -> ContainerHealthCheck

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ContainerHealthCheck

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

Formats the value using the given formatter.

impl PartialEq for ContainerHealthCheck

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