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:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnContainer.HealthCheckConfigProperty
static final class
An implementation forCfnContainer.HealthCheckConfigProperty
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
default Number
The number of consecutive health check successes required before moving the container to theHealthy
state.default Number
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
The HTTP codes to use when checking for a successful response from a container.default Number
The amount of time, in seconds, during which no response means a failed health check.default Number
The number of consecutive health check failures required before moving the container to theUnhealthy
state.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getHealthyThreshold
The number of consecutive health check successes required before moving the container to theHealthy
state.The default value is
2
.- See Also:
-
getIntervalSeconds
The approximate interval, in seconds, between health checks of an individual container.You can specify between
5
and300
seconds. The default value is5
.- See Also:
-
getPath
The path on the container on which to perform the health check.The default value is
/
.- See Also:
-
getSuccessCodes
The HTTP codes to use when checking for a successful response from a container.You can specify values between
200
and499
. You can specify multiple values (for example,200,202
) or a range of values (for example,200-299
).- See Also:
-
getTimeoutSeconds
The amount of time, in seconds, during which no response means a failed health check.You can specify between
2
and60
seconds. The default value is2
.- See Also:
-
getUnhealthyThreshold
The number of consecutive health check failures required before moving the container to theUnhealthy
state.The default value is
2
.- See Also:
-
builder
-