Skip to content

ECS  >  Dictionaries  >  GatewayConnectorHealthCheckDict

GatewayConnectorHealthCheckDict

Dictionary Type

GatewayConnectorHealthCheckDict

Bases: TypedDict

Dictionary form of GatewayConnectorHealthCheck.

Attributes

health_check_interval_seconds instance-attribute
health_check_interval_seconds: int | None

The approximate amount of time, in seconds, between health checks of an individual target.

health_check_path instance-attribute
health_check_path: str | None

The destination path for health check requests.

health_check_port instance-attribute
health_check_port: int | None

The port that the gateway uses to perform health checks on the targets.

health_check_protocol instance-attribute
health_check_protocol: str | None

The protocol that the gateway uses to perform health checks.

Valid values:

  • HTTP - Health checks are performed over HTTP.

  • HTTPS - Health checks are performed over HTTPS.

health_check_timeout_seconds instance-attribute
health_check_timeout_seconds: int | None

The amount of time, in seconds, during which no response from a target means a failed health check.

healthy_threshold_count instance-attribute
healthy_threshold_count: int | None

The number of consecutive successful health checks that a target must pass before the gateway considers it healthy.

matcher instance-attribute

The HTTP or gRPC codes that indicate a successful health check response from a target.

unhealthy_threshold_count instance-attribute
unhealthy_threshold_count: int | None

The number of consecutive failed health checks that a target must fail before the gateway considers it unhealthy.