Interface IHttpRouteMatch

The criterion for determining a request match for this Route.

Namespace: Amazon.CDK.AWS.AppMesh

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface IHttpRouteMatch

Syntax (vb)

Public Interface IHttpRouteMatch

Remarks

ExampleMetadata: infused

Examples

VirtualRouter router;
            VirtualNode node;


            router.AddRoute("route-http", new RouteBaseProps {
                RouteSpec = RouteSpec.Http(new HttpRouteSpecOptions {
                    WeightedTargets = new [] { new WeightedTarget {
                        VirtualNode = node,
                        Weight = 50
                    }, new WeightedTarget {
                        VirtualNode = node,
                        Weight = 50
                    } },
                    Match = new HttpRouteMatch {
                        Path = HttpRoutePathMatch.StartsWith("/path-to-app")
                    }
                })
            });

Synopsis

Properties

Headers	Specifies the client request headers to match on.
Method	The HTTP client request method to match on.
Path	Specifies how is the request matched based on the path part of its URL.
Port	The port to match from the request.
Protocol	The client request protocol to match on.
QueryParameters	The query parameters to match on.

Properties

Headers

Specifies the client request headers to match on.

HeaderMatch[]? Headers { get; }

Property Value

HeaderMatch[]

Remarks

All specified headers must match for the route to match.

Default: - do not match on headers

Method

The HTTP client request method to match on.

HttpRouteMethod? Method { get; }

Property Value

HttpRouteMethod?

Remarks

Default: - do not match on request method

Path

Specifies how is the request matched based on the path part of its URL.

HttpRoutePathMatch? Path { get; }

Property Value

HttpRoutePathMatch

Remarks

Default: - matches requests with all paths

Port

The port to match from the request.

double? Port { get; }

Property Value

double?

Remarks

Default: - do not match on port

Protocol

The client request protocol to match on.

HttpRouteProtocol? Protocol { get; }

Property Value

HttpRouteProtocol?

Remarks

Applicable only for HTTP2 routes.

Default: - do not match on HTTP2 request protocol

QueryParameters

The query parameters to match on.

QueryParameterMatch[]? QueryParameters { get; }

Property Value

QueryParameterMatch[]

Remarks

All specified query parameters must match for the route to match.

Default: - do not match on query parameters