aws-cdk-lib.aws_appmesh.VirtualGatewayProps

interface VirtualGatewayProps

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

Properties used when creating a new 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
meshIMeshThe Mesh which the VirtualGateway belongs to.
accessLog?AccessLogAccess Logging Configuration for the VirtualGateway.
backendDefaults?BackendDefaultsDefault Configuration Virtual Node uses to communicate with Virtual Service.
listeners?VirtualGatewayListener[]Listeners for the VirtualGateway.
virtualGatewayName?stringName of the VirtualGateway.

mesh

Type: IMesh

The Mesh which the VirtualGateway belongs to.


accessLog?

Type: AccessLog (optional, default: no access logging)

Access Logging Configuration for the VirtualGateway.


backendDefaults?

Type: BackendDefaults (optional, default: No Config)

Default Configuration Virtual Node uses to communicate with Virtual Service.


listeners?

Type: VirtualGatewayListener[] (optional, default: Single HTTP listener on port 8080)

Listeners for the VirtualGateway.

Only one is supported.


virtualGatewayName?

Type: string (optional, default: A name is automatically determined)

Name of the VirtualGateway.