Skip to content

/AWS1/CL_VL_HEALTHCHECKCONFIG

Describes the health check configuration of a target group. Health check configurations aren't used for target groups of type LAMBDA or ALB.

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_enabled TYPE /AWS1/VL_BOOLEAN /AWS1/VL_BOOLEAN

Indicates whether health checking is enabled.

iv_protocol TYPE /AWS1/VL_TARGETGROUPPROTOCOL /AWS1/VL_TARGETGROUPPROTOCOL

The protocol used when performing health checks on targets. The possible protocols are HTTP and HTTPS. The default is HTTP.

iv_protocolversion TYPE /AWS1/VL_HEALTHCHECKPROTOCOL00 /AWS1/VL_HEALTHCHECKPROTOCOL00

The protocol version used when performing health checks on targets. The possible protocol versions are HTTP1 and HTTP2.

iv_port TYPE /AWS1/VL_HEALTHCHECKPORT /AWS1/VL_HEALTHCHECKPORT

The port used when performing health checks on targets. The default setting is the port that a target receives traffic on.

iv_path TYPE /AWS1/VL_HEALTHCHECKPATH /AWS1/VL_HEALTHCHECKPATH

The destination for health checks on the targets. If the protocol version is HTTP/1.1 or HTTP/2, specify a valid URI (for example, /path?query). The default path is /. Health checks are not supported if the protocol version is gRPC, however, you can choose HTTP/1.1 or HTTP/2 and specify a valid URI.

iv_healthcheckintervalsecs TYPE /AWS1/VL_HEALTHCHECKINTERVAL00 /AWS1/VL_HEALTHCHECKINTERVAL00

The approximate amount of time, in seconds, between health checks of an individual target. The range is 5–300 seconds. The default is 30 seconds.

iv_healthchecktimeoutseconds TYPE /AWS1/VL_HEALTHCHECKTMOUTSECS /AWS1/VL_HEALTHCHECKTMOUTSECS

The amount of time, in seconds, to wait before reporting a target as unhealthy. The range is 1–120 seconds. The default is 5 seconds.

iv_healthythresholdcount TYPE /AWS1/VL_HEALTHYTHRESHOLDCOUNT /AWS1/VL_HEALTHYTHRESHOLDCOUNT

The number of consecutive successful health checks required before considering an unhealthy target healthy. The range is 2–10. The default is 5.

iv_unhealthythresholdcount TYPE /AWS1/VL_UNHEALTHYTHRESHCOUNT /AWS1/VL_UNHEALTHYTHRESHCOUNT

The number of consecutive failed health checks required before considering a target unhealthy. The range is 2–10. The default is 2.

io_matcher TYPE REF TO /AWS1/CL_VL_MATCHER /AWS1/CL_VL_MATCHER

The codes to use when checking for a successful response from a target.

Queryable Attributes

enabled

Indicates whether health checking is enabled.

Accessible with the following methods

Method Description
GET_ENABLED() Getter for ENABLED, with configurable default
ASK_ENABLED() Getter for ENABLED w/ exceptions if field has no value
HAS_ENABLED() Determine if ENABLED has a value

protocol

The protocol used when performing health checks on targets. The possible protocols are HTTP and HTTPS. The default is HTTP.

Accessible with the following methods

Method Description
GET_PROTOCOL() Getter for PROTOCOL, with configurable default
ASK_PROTOCOL() Getter for PROTOCOL w/ exceptions if field has no value
HAS_PROTOCOL() Determine if PROTOCOL has a value

protocolVersion

The protocol version used when performing health checks on targets. The possible protocol versions are HTTP1 and HTTP2.

Accessible with the following methods

Method Description
GET_PROTOCOLVERSION() Getter for PROTOCOLVERSION, with configurable default
ASK_PROTOCOLVERSION() Getter for PROTOCOLVERSION w/ exceptions if field has no val
HAS_PROTOCOLVERSION() Determine if PROTOCOLVERSION has a value

port

The port used when performing health checks on targets. The default setting is the port that a target receives traffic on.

Accessible with the following methods

Method Description
GET_PORT() Getter for PORT, with configurable default
ASK_PORT() Getter for PORT w/ exceptions if field has no value
HAS_PORT() Determine if PORT has a value

path

The destination for health checks on the targets. If the protocol version is HTTP/1.1 or HTTP/2, specify a valid URI (for example, /path?query). The default path is /. Health checks are not supported if the protocol version is gRPC, however, you can choose HTTP/1.1 or HTTP/2 and specify a valid URI.

Accessible with the following methods

Method Description
GET_PATH() Getter for PATH, with configurable default
ASK_PATH() Getter for PATH w/ exceptions if field has no value
HAS_PATH() Determine if PATH has a value

healthCheckIntervalSeconds

The approximate amount of time, in seconds, between health checks of an individual target. The range is 5–300 seconds. The default is 30 seconds.

Accessible with the following methods

Method Description
GET_HEALTHCHECKINTERVALSECS() Getter for HEALTHCHECKINTERVALSECONDS, with configurable def
ASK_HEALTHCHECKINTERVALSECS() Getter for HEALTHCHECKINTERVALSECONDS w/ exceptions if field
HAS_HEALTHCHECKINTERVALSECS() Determine if HEALTHCHECKINTERVALSECONDS has a value

healthCheckTimeoutSeconds

The amount of time, in seconds, to wait before reporting a target as unhealthy. The range is 1–120 seconds. The default is 5 seconds.

Accessible with the following methods

Method Description
GET_HEALTHCHECKTMOUTSECONDS() Getter for HEALTHCHECKTIMEOUTSECONDS, with configurable defa
ASK_HEALTHCHECKTMOUTSECONDS() Getter for HEALTHCHECKTIMEOUTSECONDS w/ exceptions if field
HAS_HEALTHCHECKTMOUTSECONDS() Determine if HEALTHCHECKTIMEOUTSECONDS has a value

healthyThresholdCount

The number of consecutive successful health checks required before considering an unhealthy target healthy. The range is 2–10. The default is 5.

Accessible with the following methods

Method Description
GET_HEALTHYTHRESHOLDCOUNT() Getter for HEALTHYTHRESHOLDCOUNT, with configurable default
ASK_HEALTHYTHRESHOLDCOUNT() Getter for HEALTHYTHRESHOLDCOUNT w/ exceptions if field has
HAS_HEALTHYTHRESHOLDCOUNT() Determine if HEALTHYTHRESHOLDCOUNT has a value

unhealthyThresholdCount

The number of consecutive failed health checks required before considering a target unhealthy. The range is 2–10. The default is 2.

Accessible with the following methods

Method Description
GET_UNHEALTHYTHRESHOLDCOUNT() Getter for UNHEALTHYTHRESHOLDCOUNT, with configurable defaul
ASK_UNHEALTHYTHRESHOLDCOUNT() Getter for UNHEALTHYTHRESHOLDCOUNT w/ exceptions if field ha
HAS_UNHEALTHYTHRESHOLDCOUNT() Determine if UNHEALTHYTHRESHOLDCOUNT has a value

matcher

The codes to use when checking for a successful response from a target.

Accessible with the following methods

Method Description
GET_MATCHER() Getter for MATCHER