Skip to content
v2.273.0

GatewayRouteProps Struct ​

Properties to define a new GatewayRoute.

Example ​

ts
// 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';

declare const gatewayRouteSpec: appmesh.GatewayRouteSpec;
declare const virtualGateway: appmesh.VirtualGateway;
const gatewayRouteProps: appmesh.GatewayRouteProps = {
  routeSpec: gatewayRouteSpec,
  virtualGateway: virtualGateway,

  // the properties below are optional
  gatewayRouteName: 'gatewayRouteName',
};

Properties ​

gatewayRouteNamestringgateway_route_namestrgatewayRouteNameStringGatewayRouteNamestringGatewayRouteName*string= an automatically generated name#
The name of the GatewayRoute.
routeSpecGatewayRouteSpecroute_specGatewayRouteSpecrouteSpecGatewayRouteSpecRouteSpecGatewayRouteSpecRouteSpecGatewayRouteSpecrequired#
What protocol the route uses.
virtualGatewayIVirtualGatewayvirtual_gatewayIVirtualGatewayvirtualGatewayIVirtualGatewayVirtualGatewayIVirtualGatewayVirtualGatewayIVirtualGatewayrequired#
The VirtualGateway this GatewayRoute is associated with.

Used as props by ​