Class CfnContainer.HealthCheckConfigProperty
HealthCheckConfig
is a property of the PublicEndpoint property. It describes the healthcheck configuration of a container deployment on a container service.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.Lightsail
Assembly: Amazon.CDK.AWS.Lightsail.dll
Syntax (csharp)
public class HealthCheckConfigProperty : Object, CfnContainer.IHealthCheckConfigProperty
Syntax (vb)
Public Class HealthCheckConfigProperty
Inherits Object
Implements 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
Constructors
HealthCheckConfigProperty() |
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 |
Constructors
HealthCheckConfigProperty()
public HealthCheckConfigProperty()
Properties
HealthyThreshold
The number of consecutive health check successes required before moving the container to the Healthy
state.
public Nullable<double> HealthyThreshold { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
IntervalSeconds
The approximate interval, in seconds, between health checks of an individual container.
public Nullable<double> IntervalSeconds { get; set; }
Property Value
System.Nullable<System.Double>
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.
public string Path { get; set; }
Property Value
System.String
Remarks
SuccessCodes
The HTTP codes to use when checking for a successful response from a container.
public string SuccessCodes { get; set; }
Property Value
System.String
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.
public Nullable<double> TimeoutSeconds { get; set; }
Property Value
System.Nullable<System.Double>
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.
public Nullable<double> UnhealthyThreshold { get; set; }
Property Value
System.Nullable<System.Double>