Interface CfnGatewayRoute.HttpGatewayRouteMatchProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnGatewayRoute.HttpGatewayRouteMatchProperty.Jsii$Proxy
- Enclosing class:
CfnGatewayRoute
@Stability(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();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnGatewayRoute.HttpGatewayRouteMatchProperty
static final class
An implementation forCfnGatewayRoute.HttpGatewayRouteMatchProperty
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
default Object
The client request headers to match on.default Object
The host name to match on.default String
The method to match on.default Object
getPath()
The path to match on.default Number
getPort()
The port number to match on.default String
Specifies the path to match requests with.default Object
The query parameter to match on.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getHeaders
The client request headers to match on.- See Also:
-
getHostname
The host name to match on.- See Also:
-
getMethod
The method to match on.- See Also:
-
getPath
The path to match on.- See Also:
-
getPort
The port number to match on.- See Also:
-
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 ismy-service.local
and you want the route to match requests tomy-service.local/metrics
, your prefix should be/metrics
.- See Also:
-
getQueryParameters
The query parameter to match on.- See Also:
-
builder
-