Skip to content
v2.277.0

HttpRouteMatch Struct ​

The criterion for determining a request match for this Route.

Example ​

ts
declare const router: appmesh.VirtualRouter;
declare const node: appmesh.VirtualNode;

router.addRoute('route-http', {
  routeSpec: appmesh.RouteSpec.http({
    weightedTargets: [
      {
        virtualNode: node,
        weight: 50,
      },
      {
        virtualNode: node,
        weight: 50,
      },
    ],
    match: {
      path: appmesh.HttpRoutePathMatch.startsWith('/path-to-app'),
    },
  }),
});
python
# router: appmesh.VirtualRouter
# node: appmesh.VirtualNode


router.add_route("route-http",
    route_spec=appmesh.RouteSpec.http(
        weighted_targets=[appmesh.WeightedTarget(
            virtual_node=node,
            weight=50
        ), appmesh.WeightedTarget(
            virtual_node=node,
            weight=50
        )
        ],
        match=appmesh.HttpRouteMatch(
            path=appmesh.HttpRoutePathMatch.starts_with("/path-to-app")
        )
    )
)
java
VirtualRouter router;
VirtualNode node;


router.addRoute("route-http", RouteBaseProps.builder()
        .routeSpec(RouteSpec.http(HttpRouteSpecOptions.builder()
                .weightedTargets(List.of(WeightedTarget.builder()
                        .virtualNode(node)
                        .weight(50)
                        .build(), WeightedTarget.builder()
                        .virtualNode(node)
                        .weight(50)
                        .build()))
                .match(HttpRouteMatch.builder()
                        .path(HttpRoutePathMatch.startsWith("/path-to-app"))
                        .build())
                .build()))
        .build());
csharp
// Install: dotnet add package Amazon.CDK.Lib
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")
        }
    })
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
var router VirtualRouter
var node VirtualNode


router.addRoute(jsii.String("route-http"), &RouteBaseProps{
	RouteSpec: appmesh.RouteSpec_Http(&HttpRouteSpecOptions{
		WeightedTargets: []WeightedTarget{
			&WeightedTarget{
				VirtualNode: node,
				Weight: jsii.Number(50),
			},
			&WeightedTarget{
				VirtualNode: node,
				Weight: jsii.Number(50),
			},
		},
		Match: &HttpRouteMatch{
			Path: appmesh.HttpRoutePathMatch_StartsWith(jsii.String("/path-to-app")),
		},
	}),
})

Properties ​

headersoptionalHeaderMatch[]headersoptionaltyping.List[HeaderMatch]headersoptionalList<HeaderMatch>HeadersoptionalHeaderMatch[]Headersoptional*[]HeaderMatch #
Specifies the client request headers to match on.

Default: do not match on headers

All specified headers must match for the route to match.

methodoptionalHttpRouteMethodmethodoptionalHttpRouteMethodmethodoptionalHttpRouteMethodMethodoptionalHttpRouteMethodMethodoptionalHttpRouteMethod #
The HTTP client request method to match on.

Default: do not match on request method

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

Default: matches requests with all paths

portoptionalnumberportoptionalint | floatportoptionalNumberPortoptionaldoublePortoptional*float64 #
The port to match from the request.

Default: do not match on port

protocoloptionalHttpRouteProtocolprotocoloptionalHttpRouteProtocolprotocoloptionalHttpRouteProtocolProtocoloptionalHttpRouteProtocolProtocoloptionalHttpRouteProtocol #
The client request protocol to match on.

Default: do not match on HTTP2 request protocol

Applicable only for HTTP2 routes.

queryParametersoptionalQueryParameterMatch[]query_parametersoptionaltyping.List[QueryParameterMatch]queryParametersoptionalList<QueryParameterMatch>QueryParametersoptionalQueryParameterMatch[]QueryParametersoptional*[]QueryParameterMatch #
The query parameters to match on.

Default: do not match on query parameters

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