aws-cdk-lib.aws_appmesh.GatewayRouteBaseProps

interface GatewayRouteBaseProps

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

Basic configuration properties for a GatewayRoute.

Example

declare const gateway: appmesh.VirtualGateway;
declare const virtualService: appmesh.VirtualService;

gateway.addGatewayRoute('gateway-route-grpc', {
  routeSpec: appmesh.GatewayRouteSpec.grpc({
    routeTarget: virtualService,
    match: {
      hostname: appmesh.GatewayRouteHostnameMatch.exactly('example.com'),
      // This disables the default rewrite to virtual service name and retain original request.
      rewriteRequestHostname: false,
    },
  }),
});

Properties

NameTypeDescription
routeSpecGatewayRouteSpecWhat protocol the route uses.
gatewayRouteName?stringThe name of the GatewayRoute.

routeSpec

Type: GatewayRouteSpec

What protocol the route uses.


gatewayRouteName?

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

The name of the GatewayRoute.