aws-cdk-lib.aws_appmesh.GatewayRouteProps

interface GatewayRouteProps

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

Properties to define a new GatewayRoute.

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

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

NameTypeDescription
routeSpecGatewayRouteSpecWhat protocol the route uses.
virtualGatewayIVirtualGatewayThe VirtualGateway this GatewayRoute is associated with.
gatewayRouteName?stringThe name of the GatewayRoute.

routeSpec

Type: GatewayRouteSpec

What protocol the route uses.


virtualGateway

Type: IVirtualGateway

The VirtualGateway this GatewayRoute is associated with.


gatewayRouteName?

Type: string (optional, default: an automatically generated name)

The name of the GatewayRoute.