Package software.amazon.awscdk.services.appmesh

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.84.0 (build 5404dcf)", date="2023-06-19T16:30:46.075Z") @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());

  • 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

      @Stability(Stable) @NotNull public static HealthCheck 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

      @Stability(Stable) @NotNull public static HealthCheck 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

      @Stability(Stable) @NotNull public static HealthCheck http2()
      Construct a HTTP2 health check.

    • tcp

      @Stability(Stable) @NotNull public static HealthCheck tcp(@Nullable TcpHealthCheckOptions options)
      Construct a TCP health check.

      Parameters:
      options -

    • tcp

      @Stability(Stable) @NotNull public static HealthCheck tcp()
      Construct a TCP health check.

    • bind

      @Stability(Stable) @NotNull public abstract HealthCheckConfig bind(@NotNull 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.