Package software.amazon.awscdk.services.appmesh

Interface TcpVirtualNodeListenerOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

TcpVirtualNodeListenerOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:46.163Z")
@Stability(Stable)
public interface TcpVirtualNodeListenerOptions
extends software.amazon.jsii.JsiiSerializable

Represent the TCP Node Listener prorperty.

Example:

 // 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.*;
 import software.amazon.awscdk.core.*;
 HealthCheck healthCheck;
 MutualTlsValidationTrust mutualTlsValidationTrust;
 SubjectAlternativeNames subjectAlternativeNames;
 TlsCertificate tlsCertificate;
 TcpVirtualNodeListenerOptions tcpVirtualNodeListenerOptions = TcpVirtualNodeListenerOptions.builder()
         .connectionPool(TcpConnectionPool.builder()
                 .maxConnections(123)
                 .build())
         .healthCheck(healthCheck)
         .outlierDetection(OutlierDetection.builder()
                 .baseEjectionDuration(Duration.minutes(30))
                 .interval(Duration.minutes(30))
                 .maxEjectionPercent(123)
                 .maxServerErrors(123)
                 .build())
         .port(123)
         .timeout(TcpTimeout.builder()
                 .idle(Duration.minutes(30))
                 .build())
         .tls(ListenerTlsOptions.builder()
                 .certificate(tlsCertificate)
                 .mode(TlsMode.STRICT)
                 // the properties below are optional
                 .mutualTlsValidation(MutualTlsValidation.builder()
                         .trust(mutualTlsValidationTrust)
                         // the properties below are optional
                         .subjectAlternativeNames(subjectAlternativeNames)
                         .build())
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static TcpVirtualNodeListenerOptions.Builder	builder()
default TcpConnectionPool	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 TcpTimeout	getTimeout()	Timeout for TCP 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 TcpConnectionPool 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 TcpTimeout getTimeout()

Timeout for TCP 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 TcpVirtualNodeListenerOptions.Builder builder()

Returns:

a TcpVirtualNodeListenerOptions.Builder of TcpVirtualNodeListenerOptions