Class HealthCheck
java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.services.appmesh.HealthCheck
- All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
date="2024-12-27T17:01:57.054Z")
@Stability(Stable)
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());
-
Nested Class Summary
Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
-
Constructor Summary
ModifierConstructorDescriptionprotected
protected
HealthCheck
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
HealthCheck
(software.amazon.jsii.JsiiObjectRef objRef) -
Method Summary
Modifier and TypeMethodDescriptionabstract HealthCheckConfig
bind
(software.constructs.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 software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Constructor Details
-
HealthCheck
protected HealthCheck(software.amazon.jsii.JsiiObjectRef objRef) -
HealthCheck
protected HealthCheck(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
HealthCheck
@Stability(Stable) protected HealthCheck()
-
-
Method Details
-
grpc
@Stability(Stable) @NotNull public static HealthCheck grpc(@Nullable GrpcHealthCheckOptions options) Construct a GRPC health check.- Parameters:
options
-
-
grpc
Construct a GRPC health check. -
http
@Stability(Stable) @NotNull public static HealthCheck http(@Nullable HttpHealthCheckOptions options) Construct a HTTP health check.- Parameters:
options
-
-
http
Construct a HTTP health check. -
http2
@Stability(Stable) @NotNull public static HealthCheck http2(@Nullable HttpHealthCheckOptions options) Construct a HTTP2 health check.- Parameters:
options
-
-
http2
Construct a HTTP2 health check. -
tcp
Construct a TCP health check.- Parameters:
options
-
-
tcp
Construct a TCP health check. -
bind
@Stability(Stable) @NotNull public abstract HealthCheckConfig bind(@NotNull software.constructs.Construct scope, @NotNull 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.
-