software.amazon.awscdk.services.appmesh

Interface CfnVirtualGateway.VirtualGatewayHealthCheckPolicyProperty

All Known Implementing Classes:

CfnVirtualGateway.VirtualGatewayHealthCheckPolicyProperty.Jsii$Proxy

Enclosing class:

CfnVirtualGateway

public static interface CfnVirtualGateway.VirtualGatewayHealthCheckPolicyProperty

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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnVirtualGateway.VirtualGatewayHealthCheckPolicyProperty.Builder A builder for CfnVirtualGateway.VirtualGatewayHealthCheckPolicyProperty
static class	CfnVirtualGateway.VirtualGatewayHealthCheckPolicyProperty.Jsii$Proxy An implementation for CfnVirtualGateway.VirtualGatewayHealthCheckPolicyProperty

Method Summary

Modifier and Type	Method and Description
static CfnVirtualGateway.VirtualGatewayHealthCheckPolicyProperty.Builder	builder()
java.lang.Number	getHealthyThreshold() The number of consecutive successful health checks that must occur before declaring the listener healthy.
java.lang.Number	getIntervalMillis() The time period in milliseconds between each health check execution.
default java.lang.String	getPath() The destination path for the health check request.
default java.lang.Number	getPort() The destination port for the health check request.
java.lang.String	getProtocol() The protocol for the health check request.
java.lang.Number	getTimeoutMillis() The amount of time to wait when receiving a response from the health check, in milliseconds.
java.lang.Number	getUnhealthyThreshold() The number of consecutive failed health checks that must occur before declaring a virtual gateway unhealthy.

Method Detail

getHealthyThreshold

java.lang.Number getHealthyThreshold()

The number of consecutive successful health checks that must occur before declaring the listener healthy.

getIntervalMillis

java.lang.Number getIntervalMillis()

The time period in milliseconds between each health check execution.

getProtocol

java.lang.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

java.lang.Number getTimeoutMillis()

The amount of time to wait when receiving a response from the health check, in milliseconds.

getUnhealthyThreshold

java.lang.Number getUnhealthyThreshold()

The number of consecutive failed health checks that must occur before declaring a virtual gateway unhealthy.

getPath

default java.lang.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

default java.lang.Number getPort()

The destination port for the health check request.

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

builder

static CfnVirtualGateway.VirtualGatewayHealthCheckPolicyProperty.Builder builder()

Returns:

a CfnVirtualGateway.VirtualGatewayHealthCheckPolicyProperty.Builder of CfnVirtualGateway.VirtualGatewayHealthCheckPolicyProperty