Interface CfnTargetGroup.HealthCheckConfigProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnTargetGroup.HealthCheckConfigProperty.Jsii$Proxy
- Enclosing class:
CfnTargetGroup
@Stability(Stable)
public static interface CfnTargetGroup.HealthCheckConfigProperty
extends software.amazon.jsii.JsiiSerializable
Describes the health check configuration of a target group.
Health check configurations aren't used for target groups of type LAMBDA
or ALB
.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.vpclattice.*; HealthCheckConfigProperty healthCheckConfigProperty = HealthCheckConfigProperty.builder() .enabled(false) .healthCheckIntervalSeconds(123) .healthCheckTimeoutSeconds(123) .healthyThresholdCount(123) .matcher(MatcherProperty.builder() .httpCode("httpCode") .build()) .path("path") .port(123) .protocol("protocol") .protocolVersion("protocolVersion") .unhealthyThresholdCount(123) .build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnTargetGroup.HealthCheckConfigProperty
static final class
An implementation forCfnTargetGroup.HealthCheckConfigProperty
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
default Object
Indicates whether health checking is enabled.default Number
The approximate amount of time, in seconds, between health checks of an individual target.default Number
The amount of time, in seconds, to wait before reporting a target as unhealthy.default Number
The number of consecutive successful health checks required before considering an unhealthy target healthy.default Object
The codes to use when checking for a successful response from a target.default String
getPath()
The destination for health checks on the targets.default Number
getPort()
The port used when performing health checks on targets.default String
The protocol used when performing health checks on targets.default String
The protocol version used when performing health checks on targets.default Number
The number of consecutive failed health checks required before considering a target unhealthy.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getEnabled
Indicates whether health checking is enabled.- See Also:
-
getHealthCheckIntervalSeconds
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.
- See Also:
-
getHealthCheckTimeoutSeconds
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.
- See Also:
-
getHealthyThresholdCount
The number of consecutive successful health checks required before considering an unhealthy target healthy.The range is 2–10. The default is 5.
- See Also:
-
getMatcher
The codes to use when checking for a successful response from a target.- See Also:
-
getPath
The destination for health checks on the targets.If the protocol version is
HTTP/1.1
orHTTP/2
, specify a valid URI (for example,/path?query
). The default path is/
. Health checks are not supported if the protocol version isgRPC
, however, you can chooseHTTP/1.1
orHTTP/2
and specify a valid URI.- See Also:
-
getPort
The port used when performing health checks on targets.The default setting is the port that a target receives traffic on.
- See Also:
-
getProtocol
The protocol used when performing health checks on targets.The possible protocols are
HTTP
andHTTPS
. The default isHTTP
.- See Also:
-
getProtocolVersion
The protocol version used when performing health checks on targets.The possible protocol versions are
HTTP1
andHTTP2
.- See Also:
-
getUnhealthyThresholdCount
The number of consecutive failed health checks required before considering a target unhealthy.The range is 2–10. The default is 2.
- See Also:
-
builder
-