Interface CfnRoute.HttpRouteMatchProperty

All Superinterfaces:
All Known Implementing Classes:
Enclosing class:

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


 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 HttpRouteMatchProperty httpRouteMatchProperty = HttpRouteMatchProperty.builder()
                 // the properties below are optional
                 // the properties below are optional
  • 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()
      a CfnRoute.HttpRouteMatchProperty.Builder of CfnRoute.HttpRouteMatchProperty