Package software.amazon.awscdk.services.lightsail

Interface CfnContainer.HealthCheckConfigProperty

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnContainer.HealthCheckConfigProperty.Jsii$Proxy
Enclosing class:
CfnContainer
@Stability(Stable) public static interface CfnContainer.HealthCheckConfigProperty extends software.amazon.jsii.JsiiSerializable
HealthCheckConfig is a property of the PublicEndpoint property. It describes the healthcheck configuration of a container deployment on a container service.

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.lightsail.*;
 HealthCheckConfigProperty healthCheckConfigProperty = HealthCheckConfigProperty.builder()
         .healthyThreshold(123)
         .intervalSeconds(123)
         .path("path")
         .successCodes("successCodes")
         .timeoutSeconds(123)
         .unhealthyThreshold(123)
         .build();

  • Method Details

    • getHealthyThreshold

      @Stability(Stable) @Nullable default Number getHealthyThreshold()
      The number of consecutive health check successes required before moving the container to the Healthy state.

      The default value is 2 .

    • getIntervalSeconds

      @Stability(Stable) @Nullable default Number getIntervalSeconds()
      The approximate interval, in seconds, between health checks of an individual container.

      You can specify between 5 and 300 seconds. The default value is 5 .

    • getPath

      @Stability(Stable) @Nullable default String getPath()
      The path on the container on which to perform the health check.

      The default value is / .

    • getSuccessCodes

      @Stability(Stable) @Nullable default String getSuccessCodes()
      The HTTP codes to use when checking for a successful response from a container.

      You can specify values between 200 and 499 . You can specify multiple values (for example, 200,202 ) or a range of values (for example, 200-299 ).

    • getTimeoutSeconds

      @Stability(Stable) @Nullable default Number getTimeoutSeconds()
      The amount of time, in seconds, during which no response means a failed health check.

      You can specify between 2 and 60 seconds. The default value is 2 .

    • getUnhealthyThreshold

      @Stability(Stable) @Nullable default Number getUnhealthyThreshold()
      The number of consecutive health check failures required before moving the container to the Unhealthy state.

      The default value is 2 .

    • builder

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