HttpRouteMatch

class aws_cdk.aws_appmesh.HttpRouteMatch(*, headers=None, method=None, path=None, protocol=None, query_parameters=None)

Bases: object

The criterion for determining a request match for this Route.

Parameters
  • headers (Optional[Sequence[HeaderMatch]]) – Specifies the client request headers to match on. All specified headers must match for the route to match. Default: - do not match on headers

  • method (Optional[HttpRouteMethod]) – The HTTP client request method to match on. Default: - do not match on request method

  • path (Optional[HttpRoutePathMatch]) – Specifies how is the request matched based on the path part of its URL. Default: - matches requests with all paths

  • protocol (Optional[HttpRouteProtocol]) – The client request protocol to match on. Applicable only for HTTP2 routes. Default: - do not match on HTTP2 request protocol

  • query_parameters (Optional[Sequence[QueryParameterMatch]]) – The query parameters to match on. All specified query parameters must match for the route to match. Default: - do not match on query parameters

ExampleMetadata

infused

Example:

# 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")
        )
    )
)

Attributes

headers

Specifies the client request headers to match on.

All specified headers must match for the route to match.

Default
  • do not match on headers

Return type

Optional[List[HeaderMatch]]

method

The HTTP client request method to match on.

Default
  • do not match on request method

Return type

Optional[HttpRouteMethod]

path

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

Default
  • matches requests with all paths

Return type

Optional[HttpRoutePathMatch]

protocol

The client request protocol to match on.

Applicable only for HTTP2 routes.

Default
  • do not match on HTTP2 request protocol

Return type

Optional[HttpRouteProtocol]

query_parameters

The query parameters to match on.

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

Default
  • do not match on query parameters

Return type

Optional[List[QueryParameterMatch]]