Package software.amazon.awscdk.services.appmesh

Interface GrpcRouteMatch

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

GrpcRouteMatch.Jsii$Proxy

@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)",
           date="2025-10-29T11:15:32.324Z")
@Stability(Stable)
public interface GrpcRouteMatch
extends software.amazon.jsii.JsiiSerializable

The criterion for determining a request match for this Route.

At least one match type must be selected.

Example:

 VirtualRouter router;
 VirtualNode node;
 router.addRoute("route-grpc-retry", RouteBaseProps.builder()
         .routeSpec(RouteSpec.grpc(GrpcRouteSpecOptions.builder()
                 .weightedTargets(List.of(WeightedTarget.builder().virtualNode(node).build()))
                 .match(GrpcRouteMatch.builder()
                         // When method name is specified, service name must be also specified.
                         .methodName("methodname")
                         .serviceName("servicename")
                         .metadata(List.of(HeaderMatch.valueStartsWith("Content-Type", "application/"), HeaderMatch.valueDoesNotStartWith("Content-Type", "text/")))
                         .build())
                 .build()))
         .build());
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	GrpcRouteMatch.Builder	A builder for GrpcRouteMatch
static final class	GrpcRouteMatch.Jsii$Proxy	An implementation for GrpcRouteMatch

Method Summary

Modifier and Type	Method	Description
static GrpcRouteMatch.Builder	builder()
default List<HeaderMatch>	getMetadata()	Create metadata based gRPC route match.
default String	getMethodName()	The method name to match from the request.
default Number	getPort()	The port to match from the request.
default String	getServiceName()	Create service name based gRPC route match.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getMetadata

@Stability(Stable)
@Nullable
default List<HeaderMatch> getMetadata()

Create metadata based gRPC route match.

All specified metadata must match for the route to match.

Default: - do not match on metadata

getMethodName

@Stability(Stable)
@Nullable
default String getMethodName()

The method name to match from the request.

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

Default: - do not match on method name

getPort

@Stability(Stable)
@Nullable
default Number getPort()

The port to match from the request.

Default: - do not match on port

getServiceName

@Stability(Stable)
@Nullable
default String getServiceName()

Create service name based gRPC route match.

Default: - do not match on service name

builder

@Stability(Stable)
static GrpcRouteMatch.Builder builder()

Returns:

a GrpcRouteMatch.Builder of GrpcRouteMatch