Package software.amazon.awscdk.services.appmesh

Interface HttpGatewayRouteSpecOptions

All Superinterfaces:

CommonGatewayRouteSpecOptions, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

HttpGatewayRouteSpecOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
           date="2024-09-11T18:01:11.279Z")
@Stability(Stable)
public interface HttpGatewayRouteSpecOptions
extends software.amazon.jsii.JsiiSerializable, CommonGatewayRouteSpecOptions

Properties specific for HTTP Based GatewayRoutes.

Example:

 VirtualGateway gateway;
 VirtualService virtualService;
 gateway.addGatewayRoute("gateway-route-http-2", GatewayRouteBaseProps.builder()
         .routeSpec(GatewayRouteSpec.http(HttpGatewayRouteSpecOptions.builder()
                 .routeTarget(virtualService)
                 .match(HttpGatewayRouteMatch.builder()
                         // This rewrites the path from '/test' to '/rewrittenPath'.
                         .path(HttpGatewayRoutePathMatch.exactly("/test", "/rewrittenPath"))
                         .build())
                 .build()))
         .build());
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static HttpGatewayRouteSpecOptions.Builder	builder()
default HttpGatewayRouteMatch	getMatch()	The criterion for determining a request match for this GatewayRoute.
IVirtualService	getRouteTarget()	The VirtualService this GatewayRoute directs traffic to.

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

getPriority

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getRouteTarget

@Stability(Stable)
@NotNull
IVirtualService getRouteTarget()

The VirtualService this GatewayRoute directs traffic to.

getMatch

@Stability(Stable)
@Nullable
default HttpGatewayRouteMatch getMatch()

The criterion for determining a request match for this GatewayRoute.

When path match is defined, this may optionally determine the path rewrite configuration.

Default: - matches any path and automatically rewrites the path to '/'

builder

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

Returns:

a HttpGatewayRouteSpecOptions.Builder of HttpGatewayRouteSpecOptions