HealthCheck

All Known Implementing Classes:: HealthCheck.Jsii$Proxy

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:43.698Z")
public interface HealthCheck

Describe the health check to a load balancer.

Example:

 IVpc vpc;
 AutoScalingGroup myAutoScalingGroup;
 LoadBalancer lb = LoadBalancer.Builder.create(this, "LB")
         .vpc(vpc)
         .internetFacing(true)
         .healthCheck(HealthCheck.builder()
                 .port(80)
                 .build())
         .build();
 lb.addTarget(myAutoScalingGroup);
 lb.addListener(LoadBalancerListener.builder()
         .externalPort(80)
         .build());

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`HealthCheck.Builder` A builder for `HealthCheck`
`static class`	`HealthCheck.Jsii$Proxy` An implementation for `HealthCheck`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`static HealthCheck.Builder`	`builder()`
`default java.lang.Number`	`getHealthyThreshold()` After how many successful checks is an instance considered healthy.
`default Duration`	`getInterval()` Number of seconds between health checks.
`default java.lang.String`	`getPath()` What path to use for HTTP or HTTPS health check (must return 200).
`java.lang.Number`	`getPort()` What port number to health check on.
`default LoadBalancingProtocol`	`getProtocol()` What protocol to use for health checking.
`default Duration`	`getTimeout()` Health check timeout.
`default java.lang.Number`	`getUnhealthyThreshold()` After how many unsuccessful checks is an instance considered unhealthy.

- Method Detail
  - getPort
```
java.lang.Number getPort()
```
    What port number to health check on.
  - getHealthyThreshold
```
default java.lang.Number getHealthyThreshold()
```
    After how many successful checks is an instance considered healthy.
    Default: 2
  - getInterval
```
default Duration getInterval()
```
    Number of seconds between health checks.
    Default: Duration.seconds(30)
  - getPath
```
default java.lang.String getPath()
```
    What path to use for HTTP or HTTPS health check (must return 200).
    For SSL and TCP health checks, accepting connections is enough to be considered healthy.
    Default: "/"
  - getProtocol
```
default LoadBalancingProtocol getProtocol()
```
    What protocol to use for health checking.
    The protocol is automatically determined from the port if it's not supplied.
    Default: Automatic
  - getTimeout
```
default Duration getTimeout()
```
    Health check timeout.
    Default: Duration.seconds(5)
  - getUnhealthyThreshold
```
default java.lang.Number getUnhealthyThreshold()
```
    After how many unsuccessful checks is an instance considered unhealthy.
    Default: 5
  - builder
```
static HealthCheck.Builder builder()
```
    Returns:
    
    a HealthCheck.Builder of HealthCheck

Interface HealthCheck

Nested Class Summary

Method Summary

Method Detail

getPort

getHealthyThreshold

getInterval

getPath

getProtocol

getTimeout

getUnhealthyThreshold

builder