aws-cdk-lib.aws_appmesh.CfnVirtualGateway.VirtualGatewayListenerProperty

interface VirtualGatewayListenerProperty

LanguageType name
.NETAmazon.CDK.AWS.AppMesh.CfnVirtualGateway.VirtualGatewayListenerProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsappmesh#CfnVirtualGateway_VirtualGatewayListenerProperty
Javasoftware.amazon.awscdk.services.appmesh.CfnVirtualGateway.VirtualGatewayListenerProperty
Pythonaws_cdk.aws_appmesh.CfnVirtualGateway.VirtualGatewayListenerProperty
TypeScript aws-cdk-lib » aws_appmesh » CfnVirtualGateway » VirtualGatewayListenerProperty

An object that represents a listener for a virtual gateway.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_appmesh as appmesh } from 'aws-cdk-lib';
const virtualGatewayListenerProperty: appmesh.CfnVirtualGateway.VirtualGatewayListenerProperty = {
  portMapping: {
    port: 123,
    protocol: 'protocol',
  },

  // the properties below are optional
  connectionPool: {
    grpc: {
      maxRequests: 123,
    },
    http: {
      maxConnections: 123,

      // the properties below are optional
      maxPendingRequests: 123,
    },
    http2: {
      maxRequests: 123,
    },
  },
  healthCheck: {
    healthyThreshold: 123,
    intervalMillis: 123,
    protocol: 'protocol',
    timeoutMillis: 123,
    unhealthyThreshold: 123,

    // the properties below are optional
    path: 'path',
    port: 123,
  },
  tls: {
    certificate: {
      acm: {
        certificateArn: 'certificateArn',
      },
      file: {
        certificateChain: 'certificateChain',
        privateKey: 'privateKey',
      },
      sds: {
        secretName: 'secretName',
      },
    },
    mode: 'mode',

    // the properties below are optional
    validation: {
      trust: {
        file: {
          certificateChain: 'certificateChain',
        },
        sds: {
          secretName: 'secretName',
        },
      },

      // the properties below are optional
      subjectAlternativeNames: {
        match: {
          exact: ['exact'],
        },
      },
    },
  },
};

Properties

NameTypeDescription
portMappingIResolvable | VirtualGatewayPortMappingPropertyThe port mapping information for the listener.
connectionPool?IResolvable | VirtualGatewayConnectionPoolPropertyThe connection pool information for the listener.
healthCheck?IResolvable | VirtualGatewayHealthCheckPolicyPropertyThe health check information for the listener.
tls?IResolvable | VirtualGatewayListenerTlsPropertyA reference to an object that represents the Transport Layer Security (TLS) properties for the listener.

portMapping

Type: IResolvable | VirtualGatewayPortMappingProperty

The port mapping information for the listener.


connectionPool?

Type: IResolvable | VirtualGatewayConnectionPoolProperty (optional)

The connection pool information for the listener.


healthCheck?

Type: IResolvable | VirtualGatewayHealthCheckPolicyProperty (optional)

The health check information for the listener.


tls?

Type: IResolvable | VirtualGatewayListenerTlsProperty (optional)

A reference to an object that represents the Transport Layer Security (TLS) properties for the listener.