aws-cdk-lib.aws_appmesh.HttpHealthCheckOptions

HttpHealthCheckOptions Struct

Properties used to define HTTP Based healthchecks.

Source

aws-appmesh/lib/health-checks.ts

Example

const vpc = new ec2.Vpc(this, 'vpc');
const namespace = new cloudmap.PrivateDnsNamespace(this, 'test-namespace', {
    vpc,
    name: 'domain.local',
});
const service = namespace.createService('Svc');

declare const mesh: appmesh.Mesh;
const node = mesh.addVirtualNode('virtual-node', {
  serviceDiscovery: appmesh.ServiceDiscovery.cloudMap(service),
  listeners: [appmesh.VirtualNodeListener.http({
    port: 8081,
    healthCheck: appmesh.HealthCheck.http({
      healthyThreshold: 3,
      interval: Duration.seconds(5), // minimum
      path: '/health-check-path',
      timeout: Duration.seconds(2), // minimum
      unhealthyThreshold: 2,
    }),
  })],
  accessLog: appmesh.AccessLog.fromFilePath('/dev/stdout'),
});

Properties

healthyThresholdnumberhealthy_thresholdint | floathealthyThresholdNumberHealthyThresholddoubleHealthyThreshold*float64= 2#

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

intervalDurationintervalDurationintervalDurationIntervalDurationIntervalDuration= Duration.seconds(5)#

The time period between each health check execution.

pathstringpathstrpathStringPathstringPath*string= /#

The destination path for the health check request.

timeoutDurationtimeoutDurationtimeoutDurationTimeoutDurationTimeoutDuration= Duration.seconds(2)#

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

unhealthyThresholdnumberunhealthy_thresholdint | floatunhealthyThresholdNumberUnhealthyThresholddoubleUnhealthyThreshold*float64= 2#

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