software.amazon.awscdk.services.appmesh

Class HealthCheck

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.appmesh.HealthCheck

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-14T16:25:34.345Z")
public abstract class HealthCheck
extends software.amazon.jsii.JsiiObject

Contains static factory methods for creating health checks for different protocols.

Example:

 Mesh mesh;
 Vpc vpc = new Vpc(this, "vpc");
 PrivateDnsNamespace namespace = PrivateDnsNamespace.Builder.create(this, "test-namespace")
         .vpc(vpc)
         .name("domain.local")
         .build();
 Service service = namespace.createService("Svc");
 VirtualNode node = mesh.addVirtualNode("virtual-node", VirtualNodeBaseProps.builder()
         .serviceDiscovery(ServiceDiscovery.cloudMap(service))
         .listeners(List.of(VirtualNodeListener.http(HttpVirtualNodeListenerOptions.builder()
                 .port(8081)
                 .healthCheck(HealthCheck.http(HttpHealthCheckOptions.builder()
                         .healthyThreshold(3)
                         .interval(Duration.seconds(5)) // minimum
                         .path("/health-check-path")
                         .timeout(Duration.seconds(2)) // minimum
                         .unhealthyThreshold(2)
                         .build()))
                 .build())))
         .accessLog(AccessLog.fromFilePath("/dev/stdout"))
         .build());
 

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	HealthCheck()
protected	HealthCheck(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	HealthCheck(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
abstract HealthCheckConfig	bind(Construct scope, HealthCheckBindOptions options) Called when the AccessLog type is initialized.
static HealthCheck	grpc() Construct a GRPC health check.
static HealthCheck	grpc(GrpcHealthCheckOptions options) Construct a GRPC health check.
static HealthCheck	http() Construct a HTTP health check.
static HealthCheck	http(HttpHealthCheckOptions options) Construct a HTTP health check.
static HealthCheck	http2() Construct a HTTP2 health check.
static HealthCheck	http2(HttpHealthCheckOptions options) Construct a HTTP2 health check.
static HealthCheck	tcp() Construct a TCP health check.
static HealthCheck	tcp(TcpHealthCheckOptions options) Construct a TCP health check.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HealthCheck

protected HealthCheck(software.amazon.jsii.JsiiObjectRef objRef)

HealthCheck

protected HealthCheck(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

HealthCheck

protected HealthCheck()

Method Detail

grpc

public static HealthCheck grpc(GrpcHealthCheckOptions options)

Construct a GRPC health check.

Parameters:

options -

grpc

public static HealthCheck grpc()

Construct a GRPC health check.

http

public static HealthCheck http(HttpHealthCheckOptions options)

Construct a HTTP health check.

Parameters:

options -

http

public static HealthCheck http()

Construct a HTTP health check.

http2

public static HealthCheck http2(HttpHealthCheckOptions options)

Construct a HTTP2 health check.

Parameters:

options -

http2

public static HealthCheck http2()

Construct a HTTP2 health check.

tcp

public static HealthCheck tcp(TcpHealthCheckOptions options)

Construct a TCP health check.

Parameters:

options -

tcp

public static HealthCheck tcp()

Construct a TCP health check.

bind

public abstract HealthCheckConfig bind(Construct scope,
                                       HealthCheckBindOptions options)

Called when the AccessLog type is initialized.

Can be used to enforce mutual exclusivity with future properties

Parameters:

scope - This parameter is required.

options - This parameter is required.