Package software.amazon.awscdk.services.appmesh

Interface GatewayRouteBaseProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

GatewayRouteProps

All Known Implementing Classes:

GatewayRouteBaseProps.Jsii$Proxy, GatewayRouteProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.106.0 (build e852934)",
           date="2025-02-12T12:31:57.853Z")
@Stability(Stable)
public interface GatewayRouteBaseProps
extends software.amazon.jsii.JsiiSerializable

Basic configuration properties 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

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

Method Summary

Modifier and Type	Method	Description
static GatewayRouteBaseProps.Builder	builder()
default String	getGatewayRouteName()	The name of the GatewayRoute.
GatewayRouteSpec	getRouteSpec()	What protocol the route uses.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getRouteSpec

@Stability(Stable)
@NotNull
GatewayRouteSpec getRouteSpec()

What protocol the route uses.

getGatewayRouteName

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

The name of the GatewayRoute.

Default: - an automatically generated name

builder

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

Returns:

a GatewayRouteBaseProps.Builder of GatewayRouteBaseProps