Package software.amazon.awscdk.services.appmesh

Class GatewayRouteSpec

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.appmesh.GatewayRouteSpec

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)",
           date="2025-10-29T11:15:32.318Z")
@Stability(Stable)
public abstract class GatewayRouteSpec
extends software.amazon.jsii.JsiiObject

Used to generate specs with different protocols for a 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.exactly("example.com"))
                         // This disables the default rewrite to virtual service name and retain original request.
                         .rewriteRequestHostname(false)
                         .build())
                 .build()))
         .build());
 

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	GatewayRouteSpec()
protected	GatewayRouteSpec(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	GatewayRouteSpec(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
abstract GatewayRouteSpecConfig	bind(software.constructs.Construct scope)	Called when the GatewayRouteSpec type is initialized.
static GatewayRouteSpec	grpc(GrpcGatewayRouteSpecOptions options)	Creates an gRPC Based GatewayRoute.
static GatewayRouteSpec	http(HttpGatewayRouteSpecOptions options)	Creates an HTTP Based GatewayRoute.
static GatewayRouteSpec	http2(HttpGatewayRouteSpecOptions options)	Creates an HTTP2 Based GatewayRoute.

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

GatewayRouteSpec

protected GatewayRouteSpec(software.amazon.jsii.JsiiObjectRef objRef)

GatewayRouteSpec

protected GatewayRouteSpec(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

GatewayRouteSpec

@Stability(Stable)
protected GatewayRouteSpec()

Method Details

grpc

@Stability(Stable)
@NotNull
public static GatewayRouteSpec grpc(@NotNull
 GrpcGatewayRouteSpecOptions options)

Creates an gRPC Based GatewayRoute.

Parameters:

options -

• no grpc gateway route.

This parameter is required.

http

@Stability(Stable)
@NotNull
public static GatewayRouteSpec http(@NotNull
 HttpGatewayRouteSpecOptions options)

Creates an HTTP Based GatewayRoute.

Parameters:

options -

• no http gateway route.

This parameter is required.

http2

@Stability(Stable)
@NotNull
public static GatewayRouteSpec http2(@NotNull
 HttpGatewayRouteSpecOptions options)

Creates an HTTP2 Based GatewayRoute.

Parameters:

options -

• no http2 gateway route.

This parameter is required.

bind

@Stability(Stable)
@NotNull
public abstract GatewayRouteSpecConfig bind(@NotNull
 software.constructs.Construct scope)

Called when the GatewayRouteSpec type is initialized.

Can be used to enforce mutual exclusivity with future properties

Parameters:

scope - This parameter is required.