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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-container-healthcheckconfig.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnContainer.HealthCheckConfigProperty.Builder	A builder for CfnContainer.HealthCheckConfigProperty
static final class	CfnContainer.HealthCheckConfigProperty.Jsii$Proxy	An implementation for CfnContainer.HealthCheckConfigProperty

Method Summary

Modifier and Type	Method	Description
static CfnContainer.HealthCheckConfigProperty.Builder	builder()
default Number	getHealthyThreshold()	The number of consecutive health check successes required before moving the container to the Healthy state.
default Number	getIntervalSeconds()	The approximate interval, in seconds, between health checks of an individual container.
default String	getPath()	The path on the container on which to perform the health check.
default String	getSuccessCodes()	The HTTP codes to use when checking for a successful response from a container.
default Number	getTimeoutSeconds()	The amount of time, in seconds, during which no response means a failed health check.
default Number	getUnhealthyThreshold()	The number of consecutive health check failures required before moving the container to the Unhealthy state.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-container-healthcheckconfig.html#cfn-lightsail-container-healthcheckconfig-healthythreshold

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-container-healthcheckconfig.html#cfn-lightsail-container-healthcheckconfig-intervalseconds

getPath

@Stability(Stable)
@Nullable
default String getPath()

The path on the container on which to perform the health check.

The default value is / .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-container-healthcheckconfig.html#cfn-lightsail-container-healthcheckconfig-path

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 ).

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-container-healthcheckconfig.html#cfn-lightsail-container-healthcheckconfig-successcodes

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-container-healthcheckconfig.html#cfn-lightsail-container-healthcheckconfig-timeoutseconds

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-container-healthcheckconfig.html#cfn-lightsail-container-healthcheckconfig-unhealthythreshold

builder

@Stability(Stable)
static CfnContainer.HealthCheckConfigProperty.Builder builder()

Returns:

a CfnContainer.HealthCheckConfigProperty.Builder of CfnContainer.HealthCheckConfigProperty