Interface CfnRoute.HttpRouteMatchProperty

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnRoute.HttpRouteMatchProperty.Jsii$Proxy
Enclosing class:
CfnRoute

@Stability(Stable) public static interface CfnRoute.HttpRouteMatchProperty extends software.amazon.jsii.JsiiSerializable
An object that represents the requirements for a route to match HTTP requests for a virtual router.

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.*;
 HttpRouteMatchProperty httpRouteMatchProperty = HttpRouteMatchProperty.builder()
         .headers(List.of(HttpRouteHeaderProperty.builder()
                 .name("name")
                 // the properties below are optional
                 .invert(false)
                 .match(HeaderMatchMethodProperty.builder()
                         .exact("exact")
                         .prefix("prefix")
                         .range(MatchRangeProperty.builder()
                                 .end(123)
                                 .start(123)
                                 .build())
                         .regex("regex")
                         .suffix("suffix")
                         .build())
                 .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()))
         .scheme("scheme")
         .build();
 
  • Method Details

    • getHeaders

      @Stability(Stable) @Nullable default Object getHeaders()
      The client request headers to match on.
    • getMethod

      @Stability(Stable) @Nullable default String getMethod()
      The client request method to match on.

      Specify only one.

    • getPath

      @Stability(Stable) @Nullable default Object getPath()
      The client request path to match on.
    • getPort

      @Stability(Stable) @Nullable default Number getPort()
      The port number to match on.
    • getPrefix

      @Stability(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(Stable) @Nullable default Object getQueryParameters()
      The client request query parameters to match on.
    • getScheme

      @Stability(Stable) @Nullable default String getScheme()
      The client request scheme to match on.

      Specify only one. Applicable only for HTTP2 routes.

    • builder

      @Stability(Stable) static CfnRoute.HttpRouteMatchProperty.Builder builder()
      Returns:
      a CfnRoute.HttpRouteMatchProperty.Builder of CfnRoute.HttpRouteMatchProperty