Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.AppMesh.Types.HttpGatewayRouteMatch

Description

Synopsis

data HttpGatewayRouteMatch = HttpGatewayRouteMatch' {
- headers :: Maybe (NonEmpty HttpGatewayRouteHeader)
- hostname :: Maybe GatewayRouteHostnameMatch
- method :: Maybe HttpMethod
- path :: Maybe HttpPathMatch
- port :: Maybe Natural
- prefix :: Maybe Text
- queryParameters :: Maybe (NonEmpty HttpQueryParameter)
}
newHttpGatewayRouteMatch :: HttpGatewayRouteMatch
httpGatewayRouteMatch_headers :: Lens' HttpGatewayRouteMatch (Maybe (NonEmpty HttpGatewayRouteHeader))
httpGatewayRouteMatch_hostname :: Lens' HttpGatewayRouteMatch (Maybe GatewayRouteHostnameMatch)
httpGatewayRouteMatch_method :: Lens' HttpGatewayRouteMatch (Maybe HttpMethod)
httpGatewayRouteMatch_path :: Lens' HttpGatewayRouteMatch (Maybe HttpPathMatch)
httpGatewayRouteMatch_port :: Lens' HttpGatewayRouteMatch (Maybe Natural)
httpGatewayRouteMatch_prefix :: Lens' HttpGatewayRouteMatch (Maybe Text)
httpGatewayRouteMatch_queryParameters :: Lens' HttpGatewayRouteMatch (Maybe (NonEmpty HttpQueryParameter))

Documentation

data HttpGatewayRouteMatch Source #

An object that represents the criteria for determining a request match.

See: newHttpGatewayRouteMatch smart constructor.

Constructors

HttpGatewayRouteMatch'

Fields

headers :: Maybe (NonEmpty HttpGatewayRouteHeader)
The client request headers to match on.
hostname :: Maybe GatewayRouteHostnameMatch
The host name to match on.
method :: Maybe HttpMethod
The method to match on.
path :: Maybe HttpPathMatch
The 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 query parameter to match on.

Instances

Instances details

FromJSON HttpGatewayRouteMatch Source #
Instance details Defined in Amazonka.AppMesh.Types.HttpGatewayRouteMatch Methods parseJSON :: Value -> Parser HttpGatewayRouteMatch # parseJSONList :: Value -> Parser [HttpGatewayRouteMatch] #
ToJSON HttpGatewayRouteMatch Source #
Instance details Defined in Amazonka.AppMesh.Types.HttpGatewayRouteMatch Methods toJSON :: HttpGatewayRouteMatch -> Value # toEncoding :: HttpGatewayRouteMatch -> Encoding # toJSONList :: [HttpGatewayRouteMatch] -> Value # toEncodingList :: [HttpGatewayRouteMatch] -> Encoding #
Generic HttpGatewayRouteMatch Source #
Instance details Defined in Amazonka.AppMesh.Types.HttpGatewayRouteMatch Associated Types type Rep HttpGatewayRouteMatch :: Type -> Type # Methods from :: HttpGatewayRouteMatch -> Rep HttpGatewayRouteMatch x # to :: Rep HttpGatewayRouteMatch x -> HttpGatewayRouteMatch #
Read HttpGatewayRouteMatch Source #
Instance details Defined in Amazonka.AppMesh.Types.HttpGatewayRouteMatch Methods readsPrec :: Int -> ReadS HttpGatewayRouteMatch # readList :: ReadS [HttpGatewayRouteMatch] # readPrec :: ReadPrec HttpGatewayRouteMatch # readListPrec :: ReadPrec [HttpGatewayRouteMatch] #
Show HttpGatewayRouteMatch Source #
Instance details Defined in Amazonka.AppMesh.Types.HttpGatewayRouteMatch Methods showsPrec :: Int -> HttpGatewayRouteMatch -> ShowS # show :: HttpGatewayRouteMatch -> String # showList :: [HttpGatewayRouteMatch] -> ShowS #
NFData HttpGatewayRouteMatch Source #
Instance details Defined in Amazonka.AppMesh.Types.HttpGatewayRouteMatch Methods rnf :: HttpGatewayRouteMatch -> () #
Eq HttpGatewayRouteMatch Source #
Instance details Defined in Amazonka.AppMesh.Types.HttpGatewayRouteMatch Methods (==) :: HttpGatewayRouteMatch -> HttpGatewayRouteMatch -> Bool # (/=) :: HttpGatewayRouteMatch -> HttpGatewayRouteMatch -> Bool #
Hashable HttpGatewayRouteMatch Source #
Instance details Defined in Amazonka.AppMesh.Types.HttpGatewayRouteMatch Methods hashWithSalt :: Int -> HttpGatewayRouteMatch -> Int # hash :: HttpGatewayRouteMatch -> Int #
type Rep HttpGatewayRouteMatch Source #
Instance details Defined in Amazonka.AppMesh.Types.HttpGatewayRouteMatch type Rep HttpGatewayRouteMatch = D1 ('MetaData "HttpGatewayRouteMatch" "Amazonka.AppMesh.Types.HttpGatewayRouteMatch" "amazonka-appmesh-2.0-GBIHUgXnP8s1LEJyvNe1ca" 'False) (C1 ('MetaCons "HttpGatewayRouteMatch'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "headers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty HttpGatewayRouteHeader))) :: (S1 ('MetaSel ('Just "hostname") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe GatewayRouteHostnameMatch)) :: 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)))))))

newHttpGatewayRouteMatch :: HttpGatewayRouteMatch Source #

Create a value of HttpGatewayRouteMatch 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:HttpGatewayRouteMatch', httpGatewayRouteMatch_headers - The client request headers to match on.

$sel:hostname:HttpGatewayRouteMatch', httpGatewayRouteMatch_hostname - The host name to match on.

$sel:method:HttpGatewayRouteMatch', httpGatewayRouteMatch_method - The method to match on.

$sel:path:HttpGatewayRouteMatch', httpGatewayRouteMatch_path - The path to match on.

$sel:port:HttpGatewayRouteMatch', httpGatewayRouteMatch_port - The port number to match on.

$sel:prefix:HttpGatewayRouteMatch', httpGatewayRouteMatch_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:HttpGatewayRouteMatch', httpGatewayRouteMatch_queryParameters - The query parameter to match on.

httpGatewayRouteMatch_headers :: Lens' HttpGatewayRouteMatch (Maybe (NonEmpty HttpGatewayRouteHeader)) Source #

The client request headers to match on.

httpGatewayRouteMatch_hostname :: Lens' HttpGatewayRouteMatch (Maybe GatewayRouteHostnameMatch) Source #

The host name to match on.

httpGatewayRouteMatch_method :: Lens' HttpGatewayRouteMatch (Maybe HttpMethod) Source #

The method to match on.

httpGatewayRouteMatch_path :: Lens' HttpGatewayRouteMatch (Maybe HttpPathMatch) Source #

The path to match on.

httpGatewayRouteMatch_port :: Lens' HttpGatewayRouteMatch (Maybe Natural) Source #

The port number to match on.

httpGatewayRouteMatch_prefix :: Lens' HttpGatewayRouteMatch (Maybe Text) Source #

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.

httpGatewayRouteMatch_queryParameters :: Lens' HttpGatewayRouteMatch (Maybe (NonEmpty HttpQueryParameter)) Source #

The query parameter to match on.