Skip to content
v2.275.0

GrpcRouteMatch Struct ​

The criterion for determining a request match for this Route.

At least one match type must be selected.

Example ​

ts
declare const router: appmesh.VirtualRouter;
declare const node: appmesh.VirtualNode;

router.addRoute('route-grpc-retry', {
  routeSpec: appmesh.RouteSpec.grpc({
    weightedTargets: [{ virtualNode: node }],
    match: {
      // When method name is specified, service name must be also specified.
      methodName: 'methodname',
      serviceName: 'servicename',
      metadata: [
        // All specified metadata must match for the route to match.
        appmesh.HeaderMatch.valueStartsWith('Content-Type', 'application/'),
        appmesh.HeaderMatch.valueDoesNotStartWith('Content-Type', 'text/'),
      ],
    },
  }),
});

Properties ​

metadataoptionalHeaderMatch[]metadataoptionaltyping.List[HeaderMatch]metadataoptionalList<HeaderMatch>MetadataoptionalHeaderMatch[]Metadataoptional*[]HeaderMatch#
Create metadata based gRPC route match.

Default: do not match on metadata

All specified metadata must match for the route to match.

methodNameoptionalstringmethod_nameoptionalstrmethodNameoptionalStringMethodNameoptionalstringMethodNameoptional*string#
The method name to match from the request.

Default: do not match on method name

If the method name is specified, service name must be also provided.

portoptionalnumberportoptionalint | floatportoptionalNumberPortoptionaldoublePortoptional*float64#
The port to match from the request.

Default: do not match on port

serviceNameoptionalstringservice_nameoptionalstrserviceNameoptionalStringServiceNameoptionalstringServiceNameoptional*string#
Create service name based gRPC route match.

Default: do not match on service name