Skip to content
v2.274.0

RouteProps Struct ​

Properties to define new Routes.

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 mesh: appmesh.Mesh;
declare const routeSpec: appmesh.RouteSpec;
declare const virtualRouter: appmesh.VirtualRouter;
const routeProps: appmesh.RouteProps = {
  mesh: mesh,
  routeSpec: routeSpec,
  virtualRouter: virtualRouter,

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

Properties ​

meshIMeshmeshIMeshmeshIMeshMeshIMeshMeshIMeshrequired#
The service mesh to define the route in.
routeNamestringroute_namestrrouteNameStringRouteNamestringRouteName*string#
The name of the route.

Default: An automatically generated name

routeSpecRouteSpecroute_specRouteSpecrouteSpecRouteSpecRouteSpecRouteSpecRouteSpecRouteSpecrequired#
Protocol specific spec.
virtualRouterIVirtualRoutervirtual_routerIVirtualRoutervirtualRouterIVirtualRouterVirtualRouterIVirtualRouterVirtualRouterIVirtualRouterrequired#
The VirtualRouter the Route belongs to.