Package software.amazon.awscdk.services.vpclattice

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
The health check configuration of a target group.

Health check configurations aren't used for LAMBDA and ALB target groups.

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();

  • Method Details

    • getEnabled

      @Stability(Stable) @Nullable default Object getEnabled()
      Indicates whether health checking is enabled.

    • getHealthCheckIntervalSeconds

      @Stability(Stable) @Nullable default Number 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.

    • getHealthCheckTimeoutSeconds

      @Stability(Stable) @Nullable default Number 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.

    • getHealthyThresholdCount

      @Stability(Stable) @Nullable default Number getHealthyThresholdCount()
      The number of consecutive successful health checks required before considering an unhealthy target healthy.

      The range is 2–10. The default is 5.

    • getMatcher

      @Stability(Stable) @Nullable default Object getMatcher()
      The codes to use when checking for a successful response from a target.

      These are called Success codes in the console.

    • getPath

      @Stability(Stable) @Nullable default String getPath()
      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.

    • getPort

      @Stability(Stable) @Nullable default Number getPort()
      The port used when performing health checks on targets.

      The default setting is the port that a target receives traffic on.

    • getProtocol

      @Stability(Stable) @Nullable default String getProtocol()
      The protocol used when performing health checks on targets.

      The possible protocols are HTTP and HTTPS . The default is HTTP .

    • getProtocolVersion

      @Stability(Stable) @Nullable default String getProtocolVersion()
      The protocol version used when performing health checks on targets.

      The possible protocol versions are HTTP1 and HTTP2 .

    • getUnhealthyThresholdCount

      @Stability(Stable) @Nullable default Number getUnhealthyThresholdCount()
      The number of consecutive failed health checks required before considering a target unhealthy.

      The range is 2–10. The default is 2.

    • builder

      @Stability(Stable) static CfnTargetGroup.HealthCheckConfigProperty.Builder builder()
      Returns:
      a CfnTargetGroup.HealthCheckConfigProperty.Builder of CfnTargetGroup.HealthCheckConfigProperty