software.amazon.awscdk.services.appmesh

Interface CfnGatewayRoute.HttpGatewayRouteMatchProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnGatewayRoute.HttpGatewayRouteMatchProperty.Jsii$Proxy

Enclosing class:

CfnGatewayRoute

@Stability(value=Stable)
public static interface CfnGatewayRoute.HttpGatewayRouteMatchProperty
extends software.amazon.jsii.JsiiSerializable

An object that represents the criteria for determining a request match.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.appmesh.*;
 HttpGatewayRouteMatchProperty httpGatewayRouteMatchProperty = HttpGatewayRouteMatchProperty.builder()
         .headers(List.of(HttpGatewayRouteHeaderProperty.builder()
                 .name("name")
                 // the properties below are optional
                 .invert(false)
                 .match(HttpGatewayRouteHeaderMatchProperty.builder()
                         .exact("exact")
                         .prefix("prefix")
                         .range(GatewayRouteRangeMatchProperty.builder()
                                 .end(123)
                                 .start(123)
                                 .build())
                         .regex("regex")
                         .suffix("suffix")
                         .build())
                 .build()))
         .hostname(GatewayRouteHostnameMatchProperty.builder()
                 .exact("exact")
                 .suffix("suffix")
                 .build())
         .method("method")
         .path(HttpPathMatchProperty.builder()
                 .exact("exact")
                 .regex("regex")
                 .build())
         .port(123)
         .prefix("prefix")
         .queryParameters(List.of(QueryParameterProperty.builder()
                 .name("name")
                 // the properties below are optional
                 .match(HttpQueryParameterMatchProperty.builder()
                         .exact("exact")
                         .build())
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnGatewayRoute.HttpGatewayRouteMatchProperty.Builder	builder()
default Object	getHeaders() The client request headers to match on.
default Object	getHostname() The host name to match on.
default String	getMethod() The method to match on.
default Object	getPath() The path to match on.
default Number	getPort() `CfnGatewayRoute.HttpGatewayRouteMatchProperty.Port`.
default String	getPrefix() Specifies the path to match requests with.
default Object	getQueryParameters() The query parameter to match on.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getHeaders

@Stability(value=Stable)
 @Nullable
default Object getHeaders()

The client request headers to match on.

getHostname

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

The host name to match on.

getMethod

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

The method to match on.

getPath

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

The path to match on.

getPort

@Stability(value=Stable)
 @Nullable
default Number getPort()

`CfnGatewayRoute.HttpGatewayRouteMatchProperty.Port`.

getPrefix

@Stability(value=Stable)
 @Nullable
default String getPrefix()

Specifies the path to match requests with.

This parameter must always start with / , which by itself matches all requests to the virtual service name. You can also match for path-based routing of requests. For example, if your virtual service name is my-service.local and you want the route to match requests to my-service.local/metrics , your prefix should be /metrics .

getQueryParameters

@Stability(value=Stable)
 @Nullable
default Object getQueryParameters()

The query parameter to match on.

builder

@Stability(value=Stable)
static CfnGatewayRoute.HttpGatewayRouteMatchProperty.Builder builder()

Returns:

a CfnGatewayRoute.HttpGatewayRouteMatchProperty.Builder of CfnGatewayRoute.HttpGatewayRouteMatchProperty