# VirtualGateway

VirtualGateway represents a newly defined App Mesh Virtual Gateway.

A virtual gateway allows resources that are outside of your mesh to communicate to resources that
are inside of your mesh.

Extends: Construct › Resource › VirtualGateway
Implements: IResource, IVirtualGateway, IEnvironmentAware, IVirtualGatewayRef, IConstruct, IDependable

- CloudFormation: [`AWS::AppMesh::VirtualGateway`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-appmesh-virtualgateway.html)
- L1 type: [`CfnVirtualGateway`](/cdk/api/v2/docs/aws-cdk-lib.aws_appmesh.CfnVirtualGateway.html)
- Source: [`aws-appmesh/lib/virtual-gateway.ts`](https://github.com/aws/aws-cdk/blob/v2.275.0/packages/aws-cdk-lib/aws-appmesh/lib/virtual-gateway.ts#L147)
- Type last changed: v2.227.0 · 21 Nov 2025

## Example

```ts
// A Virtual Node with a gRPC listener with a connection pool set
declare const mesh: appmesh.Mesh;
const node = new appmesh.VirtualNode(this, 'node', {
  mesh,
  // DNS service discovery can optionally specify the DNS response type as either LOAD_BALANCER or ENDPOINTS.
  // LOAD_BALANCER means that the DNS resolver returns a loadbalanced set of endpoints,
  // whereas ENDPOINTS means that the DNS resolver is returning all the endpoints.
  // By default, the response type is assumed to be LOAD_BALANCER
  serviceDiscovery: appmesh.ServiceDiscovery.dns('node', appmesh.DnsResponseType.ENDPOINTS),
  listeners: [appmesh.VirtualNodeListener.http({
    port: 80,
    connectionPool: {
      maxConnections: 100,
      maxPendingRequests: 10,
    },
  })],
});

// A Virtual Gateway with a gRPC listener with a connection pool set
const gateway = new appmesh.VirtualGateway(this, 'gateway', {
  mesh,
  listeners: [appmesh.VirtualGatewayListener.grpc({
    port: 8080,
    connectionPool: {
      maxRequests: 10,
    },
  })],
  virtualGatewayName: 'gateway',
});
```

## Initializer

```ts
new VirtualGateway(scope: Construct, id: string, props: VirtualGatewayProps)
```

## Construct Props

- `accessLog`: [AccessLog](/cdk/api/v2/docs/aws-cdk-lib.aws_appmesh.AccessLog.html) — Access Logging Configuration for the VirtualGateway.

  **Default:** no access logging

- `backendDefaults`: [BackendDefaults](/cdk/api/v2/docs/aws-cdk-lib.aws_appmesh.BackendDefaults.html) — Default Configuration Virtual Node uses to communicate with Virtual Service.

  **Default:** No Config

- `listeners`: [VirtualGatewayListener](/cdk/api/v2/docs/aws-cdk-lib.aws_appmesh.VirtualGatewayListener.html)[] — Listeners for the VirtualGateway.

  **Default:** Single HTTP listener on port 8080

  Only one is supported.

- `mesh`: [IMesh](/cdk/api/v2/docs/aws-cdk-lib.aws_appmesh.IMesh.html) (required) — The Mesh which the VirtualGateway belongs to.

- `virtualGatewayName`: string — Name of the VirtualGateway.

  **Default:** A name is automatically determined

## Properties

- `env`: [ResourceEnvironment](/cdk/api/v2/docs/aws-cdk-lib.interfaces.ResourceEnvironment.html) — The environment this resource belongs to.

  For resources that are created and managed in a Stack (those created by
  creating new class instances like `new Role()`, `new Bucket()`, etc.), this
  is always the same as the environment of the stack they belong to.

  For referenced resources (those obtained from referencing methods like
  `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they might be
  different than the stack they were imported into.

- `grants`: [VirtualGatewayGrants](/cdk/api/v2/docs/aws-cdk-lib.aws_appmesh.VirtualGatewayGrants.html) — Collection of grant methods for a VirtualGateway.

- `mesh`: [IMesh](/cdk/api/v2/docs/aws-cdk-lib.aws_appmesh.IMesh.html) — The Mesh that the VirtualGateway belongs to.

- `node`: [Node](/cdk/api/v2/docs/constructs.Node.html) — The tree node.

- `PROPERTY_INJECTION_ID`: string (static) — Uniquely identifies this class.

- `stack`: [Stack](/cdk/api/v2/docs/aws-cdk-lib.Stack.html) — The stack in which this resource is defined.

- `virtualGatewayArn`: string — The Amazon Resource Name (ARN) for the VirtualGateway.

- `virtualGatewayName`: string — The name of the VirtualGateway.

- `virtualGatewayRef`: [VirtualGatewayReference](/cdk/api/v2/docs/aws-cdk-lib.interfaces.aws_appmesh.VirtualGatewayReference.html) — A reference to a VirtualGateway resource.

## Methods

- `addGatewayRoute(id: string, props: GatewayRouteBaseProps): GatewayRoute` — Utility method to add a new GatewayRoute to the VirtualGateway.

- `applyCrossStackReferenceStrength(strength: ReferenceStrength): void` — Override the cross-stack reference strength for this resource.

  When set, any cross-stack reference to this resource will use the specified
  mechanism instead of the global default determined by the
  `@aws-cdk/core:defaultCrossStackReferences` context key. This is useful for
  selectively weakening specific references to avoid the "deadly embrace" problem
  without changing the app-wide default.

  **Parameters**

  - `strength` — - The reference strength to use for this resource.

- `applyRemovalPolicy(policy: RemovalPolicy): void` — Apply the given removal policy to this resource.

  The Removal Policy controls what happens to this resource when it stops
  being managed by CloudFormation, either because you've removed it from the
  CDK application or because you've made a change that requires the resource
  to be replaced.

  The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
  account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).

- `fromVirtualGatewayArn(scope: Construct, id: string, virtualGatewayArn: string): IVirtualGateway` (static) — Import an existing VirtualGateway given an ARN.

- `fromVirtualGatewayAttributes(scope: Construct, id: string, attrs: VirtualGatewayAttributes): IVirtualGateway` (static) — Import an existing VirtualGateway given its attributes.

- `grantStreamAggregatedResources(identity: IGrantable): Grant` — Grants the given entity `appmesh:StreamAggregatedResources`.

  [disable-awslint:no-grants]

- `isConstruct(x: any): boolean` (static) — Checks if `x` is a construct.

  Use this method instead of `instanceof` to properly detect `Construct`
  instances, even when the construct library is symlinked.

  Explanation: in JavaScript, multiple copies of the `constructs` library on
  disk are seen as independent, completely different libraries. As a
  consequence, the class `Construct` in each copy of the `constructs` library
  is seen as a different class, and an instance of one class will not test as
  `instanceof` the other class. `npm install` will not create installations
  like this, but users may manually symlink construct libraries together or
  use a monorepo tool: in those cases, multiple copies of the `constructs`
  library can be accidentally installed, and `instanceof` will behave
  unpredictably. It is safest to avoid using `instanceof`, and using
  this type-testing method instead.

  **Parameters**

  - `x` — Any object.

  **Returns:** true if `x` is an object created from a class which extends `Construct`.

- `isOwnedResource(construct: IConstruct): boolean` (static) — Returns true if the construct was created by CDK, and false otherwise.

- `isResource(construct: IConstruct): boolean` (static) — Check whether the given construct is a Resource.

- `toString(): string` — Returns a string representation of this construct.

- `with(...mixins: IMixin[]): IConstruct` — Applies one or more mixins to this construct.

  Mixins are applied in order. The list of constructs is captured at the
  start of the call, so constructs added by a mixin will not be visited.
  Use multiple `with()` calls if subsequent mixins should apply to added
  constructs.