Interface CfnVirtualGateway.VirtualGatewayHealthCheckPolicyProperty

All Superinterfaces:
All Known Implementing Classes:
Enclosing class:

@Stability(Stable) public static interface CfnVirtualGateway.VirtualGatewayHealthCheckPolicyProperty extends
An object that represents the health check policy for a virtual gateway's listener.


 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 VirtualGatewayHealthCheckPolicyProperty virtualGatewayHealthCheckPolicyProperty = VirtualGatewayHealthCheckPolicyProperty.builder()
         // the properties below are optional
  • Method Details

    • getHealthyThreshold

      @Stability(Stable) @NotNull Number getHealthyThreshold()
      The number of consecutive successful health checks that must occur before declaring the listener healthy.
    • getIntervalMillis

      @Stability(Stable) @NotNull Number getIntervalMillis()
      The time period in milliseconds between each health check execution.
    • getProtocol

      @Stability(Stable) @NotNull String getProtocol()
      The protocol for the health check request.

      If you specify grpc , then your service must conform to the GRPC Health Checking Protocol .

    • getTimeoutMillis

      @Stability(Stable) @NotNull Number getTimeoutMillis()
      The amount of time to wait when receiving a response from the health check, in milliseconds.
    • getUnhealthyThreshold

      @Stability(Stable) @NotNull Number getUnhealthyThreshold()
      The number of consecutive failed health checks that must occur before declaring a virtual gateway unhealthy.
    • getPath

      @Stability(Stable) @Nullable default String 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.

    • getPort

      @Stability(Stable) @Nullable default Number getPort()
      The destination port for the health check request.

      This port must match the port defined in the PortMapping for the listener.

    • builder

      a CfnVirtualGateway.VirtualGatewayHealthCheckPolicyProperty.Builder of CfnVirtualGateway.VirtualGatewayHealthCheckPolicyProperty