aws-cdk-lib.aws_appmesh.TcpVirtualNodeListenerOptions

interface TcpVirtualNodeListenerOptions

LanguageType name
.NETAmazon.CDK.AWS.AppMesh.TcpVirtualNodeListenerOptions
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsappmesh#TcpVirtualNodeListenerOptions
Javasoftware.amazon.awscdk.services.appmesh.TcpVirtualNodeListenerOptions
Pythonaws_cdk.aws_appmesh.TcpVirtualNodeListenerOptions
TypeScript (source)aws-cdk-lib » aws_appmesh » TcpVirtualNodeListenerOptions

Represent the TCP Node Listener property.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cdk from 'aws-cdk-lib';
import { aws_appmesh as appmesh } from 'aws-cdk-lib';

declare const healthCheck: appmesh.HealthCheck;
declare const mutualTlsValidationTrust: appmesh.MutualTlsValidationTrust;
declare const subjectAlternativeNames: appmesh.SubjectAlternativeNames;
declare const tlsCertificate: appmesh.TlsCertificate;
const tcpVirtualNodeListenerOptions: appmesh.TcpVirtualNodeListenerOptions = {
  connectionPool: {
    maxConnections: 123,
  },
  healthCheck: healthCheck,
  outlierDetection: {
    baseEjectionDuration: cdk.Duration.minutes(30),
    interval: cdk.Duration.minutes(30),
    maxEjectionPercent: 123,
    maxServerErrors: 123,
  },
  port: 123,
  timeout: {
    idle: cdk.Duration.minutes(30),
  },
  tls: {
    certificate: tlsCertificate,
    mode: appmesh.TlsMode.STRICT,

    // the properties below are optional
    mutualTlsValidation: {
      trust: mutualTlsValidationTrust,

      // the properties below are optional
      subjectAlternativeNames: subjectAlternativeNames,
    },
  },
};

Properties

NameTypeDescription
connectionPool?TcpConnectionPoolConnection pool for http listeners.
healthCheck?HealthCheckThe health check information for the listener.
outlierDetection?OutlierDetectionRepresents the configuration for enabling outlier detection.
port?numberPort to listen for connections on.
timeout?TcpTimeoutTimeout for TCP protocol.
tls?ListenerTlsOptionsRepresents the configuration for enabling TLS on a listener.

connectionPool?

Type: TcpConnectionPool (optional, default: None)

Connection pool for http listeners.


healthCheck?

Type: HealthCheck (optional, default: no healthcheck)

The health check information for the listener.


outlierDetection?

Type: OutlierDetection (optional, default: none)

Represents the configuration for enabling outlier detection.


port?

Type: number (optional, default: 8080)

Port to listen for connections on.


timeout?

Type: TcpTimeout (optional, default: None)

Timeout for TCP protocol.


tls?

Type: ListenerTlsOptions (optional, default: none)

Represents the configuration for enabling TLS on a listener.