libZSservicesZSamazonka-apigatewayZSamazonka-apigateway
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.APIGateway.Types.BasePathMapping

Description

 
Synopsis

Documentation

data BasePathMapping Source #

Represents the base path that callers of the API must provide as part of the URL after the domain name.

A custom domain name plus a BasePathMapping specification identifies a deployed RestApi in a given stage of the owner Account.

Use Custom Domain Names

See: newBasePathMapping smart constructor.

Constructors

BasePathMapping' 

Fields

Instances

Instances details
Eq BasePathMapping Source # 
Instance details

Defined in Amazonka.APIGateway.Types.BasePathMapping

Methods

(==) :: BasePathMapping -> BasePathMapping -> Bool #

(/=) :: BasePathMapping -> BasePathMapping -> Bool #

Read BasePathMapping Source # 
Instance details

Defined in Amazonka.APIGateway.Types.BasePathMapping

Methods

readsPrec :: Int -> ReadS BasePathMapping #

readList :: ReadS [BasePathMapping] #

readPrec :: ReadPrec BasePathMapping #

readListPrec :: ReadPrec [BasePathMapping] #

Show BasePathMapping Source # 
Instance details

Defined in Amazonka.APIGateway.Types.BasePathMapping

Methods

showsPrec :: Int -> BasePathMapping -> ShowS #

show :: BasePathMapping -> String #

showList :: [BasePathMapping] -> ShowS #

Generic BasePathMapping Source # 
Instance details

Defined in Amazonka.APIGateway.Types.BasePathMapping

Associated Types

type Rep BasePathMapping :: Type -> Type #

Methods

from :: BasePathMapping -> Rep BasePathMapping x #

to :: Rep BasePathMapping x -> BasePathMapping #

NFData BasePathMapping Source # 
Instance details

Defined in Amazonka.APIGateway.Types.BasePathMapping

Methods

rnf :: BasePathMapping -> () #

Hashable BasePathMapping Source # 
Instance details

Defined in Amazonka.APIGateway.Types.BasePathMapping

Methods

hashWithSalt :: Int -> BasePathMapping -> Int #

hash :: BasePathMapping -> Int #

FromJSON BasePathMapping Source # 
Instance details

Defined in Amazonka.APIGateway.Types.BasePathMapping

Methods

parseJSON :: Value -> Parser BasePathMapping #

parseJSONList :: Value -> Parser [BasePathMapping] #

type Rep BasePathMapping Source # 
Instance details

Defined in Amazonka.APIGateway.Types.BasePathMapping

type Rep BasePathMapping = D1 ('MetaData "BasePathMapping" "Amazonka.APIGateway.Types.BasePathMapping" "libZSservicesZSamazonka-apigatewayZSamazonka-apigateway" 'False) (C1 ('MetaCons "BasePathMapping'" 'PrefixI 'True) (S1 ('MetaSel ('Just "stage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "basePath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "restApiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newBasePathMapping :: BasePathMapping Source #

Create a value of BasePathMapping 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:stage:BasePathMapping', basePathMapping_stage - The name of the associated stage.

$sel:basePath:BasePathMapping', basePathMapping_basePath - The base path name that callers of the API must provide as part of the URL after the domain name.

$sel:restApiId:BasePathMapping', basePathMapping_restApiId - The string identifier of the associated RestApi.

basePathMapping_stage :: Lens' BasePathMapping (Maybe Text) Source #

The name of the associated stage.

basePathMapping_basePath :: Lens' BasePathMapping (Maybe Text) Source #

The base path name that callers of the API must provide as part of the URL after the domain name.

basePathMapping_restApiId :: Lens' BasePathMapping (Maybe Text) Source #

The string identifier of the associated RestApi.