software.amazon.awscdk.services.appmesh

Interface HttpGatewayRouteMatch

All Known Implementing Classes:

HttpGatewayRouteMatch.Jsii$Proxy

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:48.607Z")
public interface HttpGatewayRouteMatch

The criterion for determining a request match for this GatewayRoute.

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

Method Summary

Modifier and Type	Method and Description
static HttpGatewayRouteMatch.Builder	builder()
default java.util.List<HeaderMatch>	getHeaders() Specifies the client request headers to match on.
default GatewayRouteHostnameMatch	getHostname() The gateway route host name to be matched on.
default HttpRouteMethod	getMethod() The method to match on.
default HttpGatewayRoutePathMatch	getPath() Specify how to match requests based on the 'path' part of their URL.
default java.util.List<QueryParameterMatch>	getQueryParameters() The query parameters to match on.
default java.lang.Boolean	getRewriteRequestHostname() When `true`, rewrites the original request received at the Virtual Gateway to the destination Virtual Service name.

Method Detail

getHeaders

default java.util.List<HeaderMatch> getHeaders()

Specifies the client request headers to match on.

All specified headers must match for the gateway route to match.

Default: - do not match on headers

getHostname

default GatewayRouteHostnameMatch getHostname()

The gateway route host name to be matched on.

Default: - do not match on host name

getMethod

default HttpRouteMethod getMethod()

The method to match on.

Default: - do not match on method

getPath

default HttpGatewayRoutePathMatch getPath()

Specify how to match requests based on the 'path' part of their URL.

Default: - matches requests with any path

getQueryParameters

default java.util.List<QueryParameterMatch> getQueryParameters()

The query parameters to match on.

All specified query parameters must match for the route to match.

Default: - do not match on query parameters

getRewriteRequestHostname

default java.lang.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

builder

static HttpGatewayRouteMatch.Builder builder()

Returns:

a HttpGatewayRouteMatch.Builder of HttpGatewayRouteMatch