software.amazon.awscdk.services.appmesh

Interface HttpGatewayRouteMatch

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

HttpGatewayRouteMatch.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:36.552Z")
 @Stability(value=Stable)
public interface HttpGatewayRouteMatch
extends software.amazon.jsii.JsiiSerializable

The criterion for determining a request match for this GatewayRoute.

Example:

 // Example automatically generated from non-compiling source. May contain errors.
 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 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 List<QueryParameterMatch>	getQueryParameters() The query parameters to match on.
default Boolean	getRewriteRequestHostname() When `true`, rewrites the original request received at the Virtual Gateway to the destination Virtual Service name.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getHeaders

@Stability(value=Stable)
 @Nullable
default 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

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

The gateway route host name to be matched on.

Default: - do not match on host name

getMethod

@Stability(value=Stable)
 @Nullable
default HttpRouteMethod getMethod()

The method to match on.

Default: - do not match on method

getPath

@Stability(value=Stable)
 @Nullable
default HttpGatewayRoutePathMatch getPath()

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

Default: - matches requests with any path

getQueryParameters

@Stability(value=Stable)
 @Nullable
default 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

@Stability(value=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

builder

@Stability(value=Stable)
static HttpGatewayRouteMatch.Builder builder()

Returns:

a HttpGatewayRouteMatch.Builder of HttpGatewayRouteMatch