Interface CfnRoute.IHttpRouteMatchProperty

An object that represents the requirements for a route to match HTTP requests for a virtual router.

Namespace: Amazon.CDK.AWS.AppMesh

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface IHttpRouteMatchProperty

Syntax (vb)

Public Interface IHttpRouteMatchProperty

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-httproutematch.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.AppMesh;

var httpRouteMatchProperty = new HttpRouteMatchProperty {
    Headers = new [] { new HttpRouteHeaderProperty {
        Name = "name",

        // the properties below are optional
        Invert = false,
        Match = new HeaderMatchMethodProperty {
            Exact = "exact",
            Prefix = "prefix",
            Range = new MatchRangeProperty {
                End = 123,
                Start = 123
            },
            Regex = "regex",
            Suffix = "suffix"
        }
    } },
    Method = "method",
    Path = new HttpPathMatchProperty {
        Exact = "exact",
        Regex = "regex"
    },
    Port = 123,
    Prefix = "prefix",
    QueryParameters = new [] { new QueryParameterProperty {
        Name = "name",

        // the properties below are optional
        Match = new HttpQueryParameterMatchProperty {
            Exact = "exact"
        }
    } },
    Scheme = "scheme"
};

Synopsis

Properties

Headers	The client request headers to match on.
Method	The client request method to match on.
Path	The client request path to match on.
Port	The port number to match on.
Prefix	Specifies the path to match requests with.
QueryParameters	The client request query parameters to match on.
Scheme	The client request scheme to match on.

Properties

Headers

The client request headers to match on.

virtual object Headers { get; }

Property Value

System.Object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-httproutematch.html#cfn-appmesh-route-httproutematch-headers

Method

The client request method to match on.

virtual string Method { get; }

Property Value

System.String

Remarks

Specify only one.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-httproutematch.html#cfn-appmesh-route-httproutematch-method

Path

The client request path to match on.

virtual object Path { get; }

Property Value

System.Object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-httproutematch.html#cfn-appmesh-route-httproutematch-path

Port

The port number to match on.

virtual Nullable<double> Port { get; }

Property Value

System.Nullable<System.Double>

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-httproutematch.html#cfn-appmesh-route-httproutematch-port

Prefix

Specifies the path to match requests with.

virtual string Prefix { get; }

Property Value

System.String

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-httproutematch.html#cfn-appmesh-route-httproutematch-prefix

QueryParameters

The client request query parameters to match on.

virtual object QueryParameters { get; }

Property Value

System.Object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-httproutematch.html#cfn-appmesh-route-httproutematch-queryparameters

Scheme

The client request scheme to match on.

virtual string Scheme { get; }

Property Value

System.String

Remarks

Specify only one. Applicable only for HTTP2 routes.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-route-httproutematch.html#cfn-appmesh-route-httproutematch-scheme