software.amazon.awscdk.services.appmesh

Interface CfnRoute.HttpRouteMatchProperty

All Known Implementing Classes:

CfnRoute.HttpRouteMatchProperty.Jsii$Proxy

Enclosing class:

CfnRoute

public static interface CfnRoute.HttpRouteMatchProperty

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();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnRoute.HttpRouteMatchProperty.Builder	builder()
default java.lang.Object	getHeaders() The client request headers to match on.
default java.lang.String	getMethod() The client request method to match on.
default java.lang.Object	getPath() The client request path to match on.
default java.lang.Number	getPort() The port number to match on.
default java.lang.String	getPrefix() Specifies the path to match requests with.
default java.lang.Object	getQueryParameters() The client request query parameters to match on.
default java.lang.String	getScheme() The client request scheme to match on.

Method Detail

getHeaders

default java.lang.Object getHeaders()

The client request headers to match on.

getMethod

default java.lang.String getMethod()

The client request method to match on.

Specify only one.

getPath

default java.lang.Object getPath()

The client request path to match on.

getPort

default java.lang.Number getPort()

The port number to match on.

getPrefix

default java.lang.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

default java.lang.Object getQueryParameters()

The client request query parameters to match on.

getScheme

default java.lang.String getScheme()

The client request scheme to match on.

Specify only one. Applicable only for HTTP2 routes.

builder

static CfnRoute.HttpRouteMatchProperty.Builder builder()

Returns:

a CfnRoute.HttpRouteMatchProperty.Builder of CfnRoute.HttpRouteMatchProperty