Amazonka.AppMesh.Types.HttpRouteMatch

Documentation

data HttpRouteMatch

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

See: newHttpRouteMatch smart constructor.

Constructors

HttpRouteMatch'

Fields

• headers :: Maybe (NonEmpty HttpRouteHeader)

  The client request headers to match on.

• method :: Maybe HttpMethod

  The client request method to match on. Specify only one.

• path :: Maybe HttpPathMatch

  The client request path to match on.

• port :: Maybe Natural

  The port number to match on.

• prefix :: Maybe Text

  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.

• queryParameters :: Maybe (NonEmpty HttpQueryParameter)

  The client request query parameters to match on.

• scheme :: Maybe HttpScheme

  The client request scheme to match on. Specify only one. Applicable only for HTTP2 routes.

Instances

FromJSON HttpRouteMatch

Defined in Amazonka.AppMesh.Types.HttpRouteMatch

Methods

parseJSON :: Value -> Parser HttpRouteMatch

parseJSONList :: Value -> Parser [HttpRouteMatch]

ToJSON HttpRouteMatch

Defined in Amazonka.AppMesh.Types.HttpRouteMatch

Methods

toJSON :: HttpRouteMatch -> Value

toEncoding :: HttpRouteMatch -> Encoding

toJSONList :: [HttpRouteMatch] -> Value

toEncodingList :: [HttpRouteMatch] -> Encoding

Generic HttpRouteMatch

Defined in Amazonka.AppMesh.Types.HttpRouteMatch

Associated Types

type Rep HttpRouteMatch :: Type -> Type

Methods

from :: HttpRouteMatch -> Rep HttpRouteMatch x

to :: Rep HttpRouteMatch x -> HttpRouteMatch

Read HttpRouteMatch

Defined in Amazonka.AppMesh.Types.HttpRouteMatch

Methods

readsPrec :: Int -> ReadS HttpRouteMatch

readList :: ReadS [HttpRouteMatch]

readPrec :: ReadPrec HttpRouteMatch

readListPrec :: ReadPrec [HttpRouteMatch]

Show HttpRouteMatch

Defined in Amazonka.AppMesh.Types.HttpRouteMatch

Methods

showsPrec :: Int -> HttpRouteMatch -> ShowS

show :: HttpRouteMatch -> String

showList :: [HttpRouteMatch] -> ShowS

NFData HttpRouteMatch

Defined in Amazonka.AppMesh.Types.HttpRouteMatch

Methods

rnf :: HttpRouteMatch -> ()

Eq HttpRouteMatch

Defined in Amazonka.AppMesh.Types.HttpRouteMatch

Methods

(==) :: HttpRouteMatch -> HttpRouteMatch -> Bool

(/=) :: HttpRouteMatch -> HttpRouteMatch -> Bool

Hashable HttpRouteMatch

Defined in Amazonka.AppMesh.Types.HttpRouteMatch

Methods

hashWithSalt :: Int -> HttpRouteMatch -> Int

hash :: HttpRouteMatch -> Int

type Rep HttpRouteMatch

Defined in Amazonka.AppMesh.Types.HttpRouteMatch

type Rep HttpRouteMatch = D1 ('MetaData "HttpRouteMatch" "Amazonka.AppMesh.Types.HttpRouteMatch" "amazonka-appmesh-2.0-GBIHUgXnP8s1LEJyvNe1ca" 'False) (C1 ('MetaCons "HttpRouteMatch'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "headers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty HttpRouteHeader))) :*: (S1 ('MetaSel ('Just "method") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HttpMethod)) :*: S1 ('MetaSel ('Just "path") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HttpPathMatch)))) :*: ((S1 ('MetaSel ('Just "port") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "prefix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "queryParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty HttpQueryParameter))) :*: S1 ('MetaSel ('Just "scheme") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HttpScheme))))))

newHttpRouteMatch :: HttpRouteMatch

Create a value of HttpRouteMatch with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:headers:HttpRouteMatch', httpRouteMatch_headers - The client request headers to match on.

$sel:method:HttpRouteMatch', httpRouteMatch_method - The client request method to match on. Specify only one.

$sel:path:HttpRouteMatch', httpRouteMatch_path - The client request path to match on.

$sel:port:HttpRouteMatch', httpRouteMatch_port - The port number to match on.

$sel:prefix:HttpRouteMatch', httpRouteMatch_prefix - 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.

$sel:queryParameters:HttpRouteMatch', httpRouteMatch_queryParameters - The client request query parameters to match on.

$sel:scheme:HttpRouteMatch', httpRouteMatch_scheme - The client request scheme to match on. Specify only one. Applicable only for HTTP2 routes.

httpRouteMatch_headers :: Lens' HttpRouteMatch (Maybe (NonEmpty HttpRouteHeader))

The client request headers to match on.

httpRouteMatch_method :: Lens' HttpRouteMatch (Maybe HttpMethod)

The client request method to match on. Specify only one.

httpRouteMatch_path :: Lens' HttpRouteMatch (Maybe HttpPathMatch)

The client request path to match on.

httpRouteMatch_port :: Lens' HttpRouteMatch (Maybe Natural)

The port number to match on.

httpRouteMatch_prefix :: Lens' HttpRouteMatch (Maybe Text)

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.

httpRouteMatch_queryParameters :: Lens' HttpRouteMatch (Maybe (NonEmpty HttpQueryParameter))

The client request query parameters to match on.

httpRouteMatch_scheme :: Lens' HttpRouteMatch (Maybe HttpScheme)

The client request scheme to match on. Specify only one. Applicable only for HTTP2 routes.