aws-cdk-lib.aws_appmesh.HttpGatewayListenerOptions

interface HttpGatewayListenerOptions

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

Represents the properties needed to define HTTP Listeners for a VirtualGateway.

Example

declare const mesh: appmesh.Mesh;
const certificateAuthorityArn = 'arn:aws:acm-pca:us-east-1:123456789012:certificate-authority/12345678-1234-1234-1234-123456789012';

const gateway = new appmesh.VirtualGateway(this, 'gateway', {
  mesh: mesh,
  listeners: [appmesh.VirtualGatewayListener.http({
    port: 443,
    healthCheck: appmesh.HealthCheck.http({
      interval: Duration.seconds(10),
    }),
  })],
  backendDefaults: {
    tlsClientPolicy: {
      ports: [8080, 8081],
      validation: {
        trust: appmesh.TlsValidationTrust.acm([
          acmpca.CertificateAuthority.fromCertificateAuthorityArn(this, 'certificate', certificateAuthorityArn)]),
      },
    },
  },
  accessLog: appmesh.AccessLog.fromFilePath('/dev/stdout'),
  virtualGatewayName: 'virtualGateway',
});

Properties

NameTypeDescription
connectionPool?HttpConnectionPoolConnection pool for http listeners.
healthCheck?HealthCheckThe health check information for the listener.
port?numberPort to listen for connections on.
tls?ListenerTlsOptionsRepresents the configuration for enabling TLS on a listener.

connectionPool?

Type: HttpConnectionPool (optional, default: None)

Connection pool for http listeners.


healthCheck?

Type: HealthCheck (optional, default: no healthcheck)

The health check information for the listener.


port?

Type: number (optional, default: 8080)

Port to listen for connections on.


tls?

Type: ListenerTlsOptions (optional, default: none)

Represents the configuration for enabling TLS on a listener.