Skip to content
v2.273.0

HealthCheckConfig Struct ​

All Properties for Health Checks for mesh endpoints.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_appmesh as appmesh } from 'aws-cdk-lib';
const healthCheckConfig: appmesh.HealthCheckConfig = {
  virtualGatewayHealthCheck: {
    healthyThreshold: 123,
    intervalMillis: 123,
    protocol: 'protocol',
    timeoutMillis: 123,
    unhealthyThreshold: 123,

    // the properties below are optional
    path: 'path',
    port: 123,
  },
  virtualNodeHealthCheck: {
    healthyThreshold: 123,
    intervalMillis: 123,
    protocol: 'protocol',
    timeoutMillis: 123,
    unhealthyThreshold: 123,

    // the properties below are optional
    path: 'path',
    port: 123,
  },
};

Properties ​

virtualGatewayHealthCheckCfnVirtualGateway.VirtualGatewayHealthCheckPolicyPropertyvirtual_gateway_health_checkVirtualGatewayHealthCheckPolicyPropertyvirtualGatewayHealthCheckVirtualGatewayHealthCheckPolicyPropertyVirtualGatewayHealthCheckVirtualGatewayHealthCheckPolicyPropertyVirtualGatewayHealthCheckVirtualGatewayHealthCheckPolicyProperty= no health checks#
VirtualGateway CFN configuration for Health Checks.
virtualNodeHealthCheckCfnVirtualNode.HealthCheckPropertyvirtual_node_health_checkHealthCheckPropertyvirtualNodeHealthCheckHealthCheckPropertyVirtualNodeHealthCheckHealthCheckPropertyVirtualNodeHealthCheckHealthCheckProperty= no health checks#
VirtualNode CFN configuration for Health Checks.