appmesh/aws.sdk.kotlin.services.appmesh.model/VirtualGatewayHealthCheckPolicy

VirtualGatewayHealthCheckPolicy

class VirtualGatewayHealthCheckPolicy

An object that represents the health check policy for a virtual gateway's listener.

Types

Builder

class Builder

Companion

object Companion

Properties

healthyThreshold

val healthyThreshold: Int

The number of consecutive successful health checks that must occur before declaring the listener healthy.

intervalMillis

val intervalMillis: Long

The time period in milliseconds between each health check execution.

path

val path: String?

The destination path for the health check request. This value is only used if the specified protocol is HTTP or HTTP/2. For any other protocol, this value is ignored.

port

val port: Int?

The destination port for the health check request. This port must match the port defined in the PortMapping for the listener.

protocol

val protocol: VirtualGatewayPortProtocol

The protocol for the health check request. If you specify grpc, then your service must conform to the GRPC Health Checking Protocol.

timeoutMillis

val timeoutMillis: Long

The amount of time to wait when receiving a response from the health check, in milliseconds.

unhealthyThreshold

val unhealthyThreshold: Int

The number of consecutive failed health checks that must occur before declaring a virtual gateway unhealthy.

Functions

copy

inline fun copy(block: VirtualGatewayHealthCheckPolicy.Builder.() -> Unit = {}): VirtualGatewayHealthCheckPolicy

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String