Package software.amazon.awscdk.services.appmesh

Interface GrpcRouteSpecOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable, RouteSpecOptionsBase

All Known Implementing Classes:

GrpcRouteSpecOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)",
           date="2025-11-04T09:27:34.241Z")
@Stability(Stable)
public interface GrpcRouteSpecOptions
extends software.amazon.jsii.JsiiSerializable, RouteSpecOptionsBase

Properties specific for a GRPC Based Routes.

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	GrpcRouteSpecOptions.Builder	A builder for GrpcRouteSpecOptions
static final class	GrpcRouteSpecOptions.Jsii$Proxy	An implementation for GrpcRouteSpecOptions

Method Summary

Modifier and Type	Method	Description
static GrpcRouteSpecOptions.Builder	builder()
GrpcRouteMatch	getMatch()	The criterion for determining a request match for this Route.
default GrpcRetryPolicy	getRetryPolicy()	The retry policy.
default GrpcTimeout	getTimeout()	An object that represents a grpc timeout.
List<WeightedTarget>	getWeightedTargets()	List of targets that traffic is routed to when a request matches the route.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Methods inherited from interface software.amazon.awscdk.services.appmesh.RouteSpecOptionsBase

getPriority

Method Details

getMatch

@Stability(Stable)
@NotNull
GrpcRouteMatch getMatch()

The criterion for determining a request match for this Route.

getWeightedTargets

@Stability(Stable)
@NotNull
List<WeightedTarget> getWeightedTargets()

List of targets that traffic is routed to when a request matches the route.

getRetryPolicy

@Stability(Stable)
@Nullable
default GrpcRetryPolicy getRetryPolicy()

The retry policy.

Default: - no retry policy

getTimeout

@Stability(Stable)
@Nullable
default GrpcTimeout getTimeout()

An object that represents a grpc timeout.

Default: - None

builder

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

Returns:

a GrpcRouteSpecOptions.Builder of GrpcRouteSpecOptions