Package software.amazon.awscdk.services.appmesh

Interface GrpcGatewayRouteMatch

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

GrpcGatewayRouteMatch.Jsii$Proxy

@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)",
           date="2025-10-24T13:34:31.123Z")
@Stability(Stable)
public interface GrpcGatewayRouteMatch
extends software.amazon.jsii.JsiiSerializable

The criterion for determining a request match for this GatewayRoute.

Example:

 VirtualGateway gateway;
 VirtualService virtualService;
 gateway.addGatewayRoute("gateway-route-grpc", GatewayRouteBaseProps.builder()
         .routeSpec(GatewayRouteSpec.grpc(GrpcGatewayRouteSpecOptions.builder()
                 .routeTarget(virtualService)
                 .match(GrpcGatewayRouteMatch.builder()
                         .hostname(GatewayRouteHostnameMatch.endsWith(".example.com"))
                         .build())
                 .build()))
         .build());
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static GrpcGatewayRouteMatch.Builder	builder()
default GatewayRouteHostnameMatch	getHostname()	Create host name based gRPC gateway route match.
default List<HeaderMatch>	getMetadata()	Create metadata based gRPC gateway route match.
default Number	getPort()	The port to match from the request.
default Boolean	getRewriteRequestHostname()	When true, rewrites the original request received at the Virtual Gateway to the destination Virtual Service name.
default String	getServiceName()	Create service name based gRPC gateway route match.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getHostname

@Stability(Stable)
@Nullable
default GatewayRouteHostnameMatch getHostname()

Create host name based gRPC gateway route match.

Default: - no matching on host name

getMetadata

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

Create metadata based gRPC gateway route match.

All specified metadata must match for the route to match.

Default: - no matching on metadata

getPort

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

The port to match from the request.

Default: - do not match on port

getRewriteRequestHostname

@Stability(Stable)
@Nullable
default Boolean getRewriteRequestHostname()

When true, rewrites the original request received at the Virtual Gateway to the destination Virtual Service name.

When false, retains the original hostname from the request.

Default: true

getServiceName

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

Create service name based gRPC gateway route match.

Default: - no matching on service name

builder

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

Returns:

a GrpcGatewayRouteMatch.Builder of GrpcGatewayRouteMatch