Class CfnVirtualGateway.VirtualGatewayHealthCheckPolicyProperty
An object that represents the health check policy for a virtual gateway's listener.
Inheritance
Namespace: Amazon.CDK.AWS.AppMesh
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class VirtualGatewayHealthCheckPolicyProperty : Object, CfnVirtualGateway.IVirtualGatewayHealthCheckPolicyProperty
Syntax (vb)
Public Class VirtualGatewayHealthCheckPolicyProperty
Inherits Object
Implements CfnVirtualGateway.IVirtualGatewayHealthCheckPolicyProperty
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.AppMesh;
var virtualGatewayHealthCheckPolicyProperty = new VirtualGatewayHealthCheckPolicyProperty {
HealthyThreshold = 123,
IntervalMillis = 123,
Protocol = "protocol",
TimeoutMillis = 123,
UnhealthyThreshold = 123,
// the properties below are optional
Path = "path",
Port = 123
};
Synopsis
Constructors
VirtualGatewayHealthCheckPolicyProperty() |
Properties
HealthyThreshold | The number of consecutive successful health checks that must occur before declaring the listener healthy. |
IntervalMillis | The time period in milliseconds between each health check execution. |
Path | The destination path for the health check request. |
Port | The destination port for the health check request. |
Protocol | The protocol for the health check request. |
TimeoutMillis | The amount of time to wait when receiving a response from the health check, in milliseconds. |
UnhealthyThreshold | The number of consecutive failed health checks that must occur before declaring a virtual gateway unhealthy. |
Constructors
VirtualGatewayHealthCheckPolicyProperty()
public VirtualGatewayHealthCheckPolicyProperty()
Properties
HealthyThreshold
The number of consecutive successful health checks that must occur before declaring the listener healthy.
public double HealthyThreshold { get; set; }
Property Value
System.Double
Remarks
IntervalMillis
The time period in milliseconds between each health check execution.
public double IntervalMillis { get; set; }
Property Value
System.Double
Remarks
Path
The destination path for the health check request.
public string Path { get; set; }
Property Value
System.String
Remarks
This value is only used if the specified protocol is HTTP or HTTP/2. For any other protocol, this value is ignored.
Port
The destination port for the health check request.
public Nullable<double> Port { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
This port must match the port defined in the PortMapping
for the listener.
Protocol
The protocol for the health check request.
public string Protocol { get; set; }
Property Value
System.String
Remarks
If you specify grpc
, then your service must conform to the GRPC Health Checking Protocol .
TimeoutMillis
The amount of time to wait when receiving a response from the health check, in milliseconds.
public double TimeoutMillis { get; set; }
Property Value
System.Double
Remarks
UnhealthyThreshold
The number of consecutive failed health checks that must occur before declaring a virtual gateway unhealthy.
public double UnhealthyThreshold { get; set; }
Property Value
System.Double