Skip to content
v2.274.0

GrpcRouteSpecOptions Struct ​

Properties specific for a GRPC Based Routes.

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 ​

The criterion for determining a request match for this Route.
prioritynumberpriorityint | floatpriorityNumberPrioritydoublePriority*float64= no particular priority#
The priority for the route.

When a Virtual Router has multiple routes, route match is performed in the order of specified value, where 0 is the highest priority, and first matched route is selected.

retryPolicyGrpcRetryPolicyretry_policyGrpcRetryPolicyretryPolicyGrpcRetryPolicyRetryPolicyGrpcRetryPolicyRetryPolicyGrpcRetryPolicy= no retry policy#
The retry policy.
timeoutGrpcTimeouttimeoutGrpcTimeouttimeoutGrpcTimeoutTimeoutGrpcTimeoutTimeoutGrpcTimeout= None#
An object that represents a grpc timeout.
weightedTargetsWeightedTarget[]weighted_targetstyping.List[WeightedTarget]weightedTargetsList<WeightedTarget>WeightedTargetsWeightedTarget[]WeightedTargets*[]WeightedTargetrequired#
List of targets that traffic is routed to when a request matches the route.