Package software.amazon.awscdk.services.appmesh

Interface HttpVirtualNodeListenerOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

HttpVirtualNodeListenerOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-08T21:35:02.704Z")
@Stability(Stable)
public interface HttpVirtualNodeListenerOptions
extends software.amazon.jsii.JsiiSerializable

Represent the HTTP Node Listener property.

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

Modifier and Type	Interface	Description
static final class	HttpVirtualNodeListenerOptions.Builder	A builder for HttpVirtualNodeListenerOptions
static final class	HttpVirtualNodeListenerOptions.Jsii$Proxy	An implementation for HttpVirtualNodeListenerOptions

Method Summary

Modifier and Type	Method	Description
static HttpVirtualNodeListenerOptions.Builder	builder()
default HttpConnectionPool	getConnectionPool()	Connection pool for http listeners.
default HealthCheck	getHealthCheck()	The health check information for the listener.
default OutlierDetection	getOutlierDetection()	Represents the configuration for enabling outlier detection.
default Number	getPort()	Port to listen for connections on.
default HttpTimeout	getTimeout()	Timeout for HTTP protocol.
default ListenerTlsOptions	getTls()	Represents the configuration for enabling TLS on a listener.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getConnectionPool

@Stability(Stable)
@Nullable
default HttpConnectionPool getConnectionPool()

Connection pool for http listeners.

Default: - None

getHealthCheck

@Stability(Stable)
@Nullable
default HealthCheck getHealthCheck()

The health check information for the listener.

Default: - no healthcheck

getOutlierDetection

@Stability(Stable)
@Nullable
default OutlierDetection getOutlierDetection()

Represents the configuration for enabling outlier detection.

Default: - none

getPort

@Stability(Stable)
@Nullable
default Number getPort()

Port to listen for connections on.

Default: - 8080

getTimeout

@Stability(Stable)
@Nullable
default HttpTimeout getTimeout()

Timeout for HTTP protocol.

Default: - None

getTls

@Stability(Stable)
@Nullable
default ListenerTlsOptions getTls()

Represents the configuration for enabling TLS on a listener.

Default: - none

builder

@Stability(Stable)
static HttpVirtualNodeListenerOptions.Builder builder()

Returns:

a HttpVirtualNodeListenerOptions.Builder of HttpVirtualNodeListenerOptions