Interface CfnContainer.IHealthCheckConfigProperty
HealthCheckConfig
is a property of the PublicEndpoint property. It describes the healthcheck configuration of a container deployment on a container service.
Namespace: Amazon.CDK.AWS.Lightsail
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface CfnContainer.IHealthCheckConfigProperty
Syntax (vb)
Public Interface CfnContainer.IHealthCheckConfigProperty
Remarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Lightsail;
var healthCheckConfigProperty = new HealthCheckConfigProperty {
HealthyThreshold = 123,
IntervalSeconds = 123,
Path = "path",
SuccessCodes = "successCodes",
TimeoutSeconds = 123,
UnhealthyThreshold = 123
};
Synopsis
Properties
HealthyThreshold | The number of consecutive health check successes required before moving the container to the |
IntervalSeconds | The approximate interval, in seconds, between health checks of an individual container. |
Path | The path on the container on which to perform the health check. |
SuccessCodes | The HTTP codes to use when checking for a successful response from a container. |
TimeoutSeconds | The amount of time, in seconds, during which no response means a failed health check. |
UnhealthyThreshold | The number of consecutive health check failures required before moving the container to the |
Properties
HealthyThreshold
The number of consecutive health check successes required before moving the container to the Healthy
state.
double? HealthyThreshold { get; }
Property Value
Remarks
IntervalSeconds
The approximate interval, in seconds, between health checks of an individual container.
double? IntervalSeconds { get; }
Property Value
Remarks
You can specify between 5
and 300
seconds. The default value is 5
.
Path
The path on the container on which to perform the health check.
string? Path { get; }
Property Value
Remarks
SuccessCodes
The HTTP codes to use when checking for a successful response from a container.
string? SuccessCodes { get; }
Property Value
Remarks
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
).
TimeoutSeconds
The amount of time, in seconds, during which no response means a failed health check.
double? TimeoutSeconds { get; }
Property Value
Remarks
You can specify between 2
and 60
seconds. The default value is 2
.
UnhealthyThreshold
The number of consecutive health check failures required before moving the container to the Unhealthy
state.
double? UnhealthyThreshold { get; }