Interface CfnVirtualGateway.VirtualGatewayHealthCheckPolicyProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnVirtualGateway.VirtualGatewayHealthCheckPolicyProperty.Jsii$Proxy
- Enclosing class:
CfnVirtualGateway
@Stability(Stable)
public static interface CfnVirtualGateway.VirtualGatewayHealthCheckPolicyProperty
extends software.amazon.jsii.JsiiSerializable
An object that represents the health check policy for a virtual gateway's listener.
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.appmesh.*; VirtualGatewayHealthCheckPolicyProperty virtualGatewayHealthCheckPolicyProperty = VirtualGatewayHealthCheckPolicyProperty.builder() .healthyThreshold(123) .intervalMillis(123) .protocol("protocol") .timeoutMillis(123) .unhealthyThreshold(123) // the properties below are optional .path("path") .port(123) .build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
static final class
An implementation forCfnVirtualGateway.VirtualGatewayHealthCheckPolicyProperty
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
The number of consecutive successful health checks that must occur before declaring the listener healthy.The time period in milliseconds between each health check execution.default String
getPath()
The destination path for the health check request.default Number
getPort()
The destination port for the health check request.The protocol for the health check request.The amount of time to wait when receiving a response from the health check, in milliseconds.The number of consecutive failed health checks that must occur before declaring a virtual gateway unhealthy.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getHealthyThreshold
The number of consecutive successful health checks that must occur before declaring the listener healthy.- See Also:
-
getIntervalMillis
The time period in milliseconds between each health check execution.- See Also:
-
getProtocol
The protocol for the health check request.If you specify
grpc
, then your service must conform to the GRPC Health Checking Protocol .- See Also:
-
getTimeoutMillis
The amount of time to wait when receiving a response from the health check, in milliseconds.- See Also:
-
getUnhealthyThreshold
The number of consecutive failed health checks that must occur before declaring a virtual gateway unhealthy.- See Also:
-
getPath
The destination path for the health check request.This value is only used if the specified protocol is HTTP or HTTP/2. For any other protocol, this value is ignored.
- See Also:
-
getPort
The destination port for the health check request.This port must match the port defined in the
PortMapping
for the listener.- See Also:
-
builder
@Stability(Stable) static CfnVirtualGateway.VirtualGatewayHealthCheckPolicyProperty.Builder builder()
-