GradientEdge CDK Utils
    Preparing search index...
    interface HealthCheck {
        enabled?: boolean;
        healthyGrpcCodes?: string;
        healthyHttpCodes?: string;
        healthyThresholdCount?: number;
        interval?: Duration;
        intervalInSecs: number;
        path?: string;
        port?: string;
        protocol?: Protocol;
        timeout?: Duration;
        timeoutInSecs: number;
        unhealthyThresholdCount?: number;
    }

    Hierarchy

    • HealthCheck
      • HealthCheck
    Index

    Properties

    enabled?: boolean

    Indicates whether health checks are enabled. If the target type is lambda, health checks are disabled by default but can be enabled. If the target type is instance or ip, health checks are always enabled and cannot be disabled.

    - Determined automatically.
    
    healthyGrpcCodes?: string

    GRPC code to use when checking for a successful response from a target.

    You can specify values between 0 and 99. You can specify multiple values (for example, "0,1") or a range of values (for example, "0-5").

    12
    
    healthyHttpCodes?: string

    HTTP code to use when checking for a successful response from a target.

    For Application Load Balancers, you can specify values between 200 and 499, and the default value is 200. You can specify multiple values (for example, "200,202") or a range of values (for example, "200-299").

    healthyThresholdCount?: number

    The number of consecutive health checks successes required before considering an unhealthy target healthy.

    For Application Load Balancers, the default is 5. For Network Load Balancers, the default is 3.

    - 5 for ALBs, 3 for NLBs
    
    interval?: Duration

    The approximate number of seconds between health checks for an individual target. Must be 5 to 300 seconds

    • 10 seconds if protocol is GENEVE, 35 seconds if target type is lambda, else 30 seconds
    intervalInSecs: number
    path?: string

    The ping path destination where Elastic Load Balancing sends health check requests.

    /
    
    port?: string

    The port that the load balancer uses when performing health checks on the targets.

    'traffic-port'
    
    protocol?: Protocol

    The protocol the load balancer uses when performing health checks on targets.

    The TCP protocol is supported for health checks only if the protocol of the target group is TCP, TLS, UDP, or TCP_UDP. The TLS, UDP, and TCP_UDP protocols are not supported for health checks.

    - HTTP for ALBs, TCP for NLBs
    
    timeout?: Duration

    The amount of time, in seconds, during which no response from a target means a failed health check. Must be 2 to 120 seconds.

    • 6 seconds if the protocol is HTTP, 5 seconds if protocol is GENEVE, 30 seconds if target type is lambda, 10 seconds for TCP, TLS, or HTTPS
    timeoutInSecs: number
    unhealthyThresholdCount?: number

    The number of consecutive health check failures required before considering a target unhealthy.

    For Application Load Balancers, the default is 2. For Network Load Balancers, the range is between 2-10 and can be set accordingly.

    2