aws-cdk-lib.aws_appmesh.HealthCheckConfig

HealthCheckConfig Struct

All Properties for Health Checks for mesh endpoints.

Source

aws-appmesh/lib/health-checks.ts

Example

// 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,
  },
};

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_appmesh as appmesh

health_check_config = appmesh.HealthCheckConfig(
    virtual_gateway_health_check=appmesh.CfnVirtualGateway.VirtualGatewayHealthCheckPolicyProperty(
        healthy_threshold=123,
        interval_millis=123,
        protocol="protocol",
        timeout_millis=123,
        unhealthy_threshold=123,

        # the properties below are optional
        path="path",
        port=123
    ),
    virtual_node_health_check=appmesh.CfnVirtualNode.HealthCheckProperty(
        healthy_threshold=123,
        interval_millis=123,
        protocol="protocol",
        timeout_millis=123,
        unhealthy_threshold=123,

        # the properties below are optional
        path="path",
        port=123
    )
)

// 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.*;

HealthCheckConfig healthCheckConfig = HealthCheckConfig.builder()
        .virtualGatewayHealthCheck(VirtualGatewayHealthCheckPolicyProperty.builder()
                .healthyThreshold(123)
                .intervalMillis(123)
                .protocol("protocol")
                .timeoutMillis(123)
                .unhealthyThreshold(123)

                // the properties below are optional
                .path("path")
                .port(123)
                .build())
        .virtualNodeHealthCheck(HealthCheckProperty.builder()
                .healthyThreshold(123)
                .intervalMillis(123)
                .protocol("protocol")
                .timeoutMillis(123)
                .unhealthyThreshold(123)

                // the properties below are optional
                .path("path")
                .port(123)
                .build())
        .build();

// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.AppMesh;

var healthCheckConfig = new HealthCheckConfig {
    VirtualGatewayHealthCheck = new VirtualGatewayHealthCheckPolicyProperty {
        HealthyThreshold = 123,
        IntervalMillis = 123,
        Protocol = "protocol",
        TimeoutMillis = 123,
        UnhealthyThreshold = 123,

        // the properties below are optional
        Path = "path",
        Port = 123
    },
    VirtualNodeHealthCheck = new HealthCheckProperty {
        HealthyThreshold = 123,
        IntervalMillis = 123,
        Protocol = "protocol",
        TimeoutMillis = 123,
        UnhealthyThreshold = 123,

        // the properties below are optional
        Path = "path",
        Port = 123
    }
};

// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

healthCheckConfig := &HealthCheckConfig{
	VirtualGatewayHealthCheck: &VirtualGatewayHealthCheckPolicyProperty{
		HealthyThreshold: jsii.Number(123),
		IntervalMillis: jsii.Number(123),
		Protocol: jsii.String("protocol"),
		TimeoutMillis: jsii.Number(123),
		UnhealthyThreshold: jsii.Number(123),

		// the properties below are optional
		Path: jsii.String("path"),
		Port: jsii.Number(123),
	},
	VirtualNodeHealthCheck: &HealthCheckProperty{
		HealthyThreshold: jsii.Number(123),
		IntervalMillis: jsii.Number(123),
		Protocol: jsii.String("protocol"),
		TimeoutMillis: jsii.Number(123),
		UnhealthyThreshold: jsii.Number(123),

		// the properties below are optional
		Path: jsii.String("path"),
		Port: jsii.Number(123),
	},
}

Properties

virtualGatewayHealthCheck?optionalCfnVirtualGateway.VirtualGatewayHealthCheckPolicyPropertyvirtual_gateway_health_check?optionalVirtualGatewayHealthCheckPolicyPropertyvirtualGatewayHealthCheck?optionalVirtualGatewayHealthCheckPolicyPropertyVirtualGatewayHealthCheck?optionalVirtualGatewayHealthCheckPolicyPropertyVirtualGatewayHealthCheck?optionalVirtualGatewayHealthCheckPolicyProperty#

VirtualGateway CFN configuration for Health Checks.

Default: no health checks

virtualNodeHealthCheck?optionalCfnVirtualNode.HealthCheckPropertyvirtual_node_health_check?optionalHealthCheckPropertyvirtualNodeHealthCheck?optionalHealthCheckPropertyVirtualNodeHealthCheck?optionalHealthCheckPropertyVirtualNodeHealthCheck?optionalHealthCheckProperty#

VirtualNode CFN configuration for Health Checks.

Default: no health checks