GatewayConnectorHealthCheck¶
Structure Class¶
GatewayConnectorHealthCheck
dataclass
¶
Bases: _SerdeShape
The health check configuration that a gateway uses to evaluate the targets associated with a gateway connector.
Attributes¶
health_check_interval_seconds
class-attribute
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
class-attribute
instance-attribute
¶
health_check_path: str | None = ...
The destination path for health check requests.
health_check_port
class-attribute
instance-attribute
¶
health_check_port: int | None = ...
The port that the gateway uses to perform health checks on the targets.
health_check_protocol
class-attribute
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
class-attribute
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
class-attribute
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
class-attribute
instance-attribute
¶
matcher: GatewayConnectorHealthCheckMatcher | None = ...
The HTTP or gRPC codes that indicate a successful health check response from a target.