Copyright	(c) 2013-2018 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None
Language	Haskell2010

Network.AWS.APIGateway.CreateBasePathMapping

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a new BasePathMapping resource.

Creating a Request

createBasePathMapping #

Arguments

:: Text	`cbpmDomainName`
-> Text	`cbpmRestAPIId`
-> CreateBasePathMapping

Creates a value of CreateBasePathMapping with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

cbpmStage - The name of the API's stage that you want to use for this mapping. Leave this blank if you do not want callers to explicitly specify the stage name after any base path name.
cbpmBasePath - The base path name that callers of the API must provide as part of the URL after the domain name. This value must be unique for all of the mappings across a single API. Leave this blank if you do not want callers to specify a base path name after the domain name.
cbpmDomainName - [Required] The domain name of the BasePathMapping resource to create.
cbpmRestAPIId - [Required] The string identifier of the associated RestApi .

data CreateBasePathMapping #

Requests API Gateway to create a new BasePathMapping resource.

See: createBasePathMapping smart constructor.

Instances

Eq CreateBasePathMapping #
Instance details Defined in Network.AWS.APIGateway.CreateBasePathMapping Methods (==) :: CreateBasePathMapping -> CreateBasePathMapping -> Bool # (/=) :: CreateBasePathMapping -> CreateBasePathMapping -> Bool #
Data CreateBasePathMapping #
Instance details Defined in Network.AWS.APIGateway.CreateBasePathMapping Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateBasePathMapping -> c CreateBasePathMapping # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateBasePathMapping # toConstr :: CreateBasePathMapping -> Constr # dataTypeOf :: CreateBasePathMapping -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c CreateBasePathMapping) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateBasePathMapping) # gmapT :: (forall b. Data b => b -> b) -> CreateBasePathMapping -> CreateBasePathMapping # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateBasePathMapping -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateBasePathMapping -> r # gmapQ :: (forall d. Data d => d -> u) -> CreateBasePathMapping -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateBasePathMapping -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateBasePathMapping -> m CreateBasePathMapping # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateBasePathMapping -> m CreateBasePathMapping # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateBasePathMapping -> m CreateBasePathMapping #
Read CreateBasePathMapping #
Instance details Defined in Network.AWS.APIGateway.CreateBasePathMapping Methods readsPrec :: Int -> ReadS CreateBasePathMapping # readList :: ReadS [CreateBasePathMapping] # readPrec :: ReadPrec CreateBasePathMapping # readListPrec :: ReadPrec [CreateBasePathMapping] #
Show CreateBasePathMapping #
Instance details Defined in Network.AWS.APIGateway.CreateBasePathMapping Methods showsPrec :: Int -> CreateBasePathMapping -> ShowS # show :: CreateBasePathMapping -> String # showList :: [CreateBasePathMapping] -> ShowS #
Generic CreateBasePathMapping #
Instance details Defined in Network.AWS.APIGateway.CreateBasePathMapping Associated Types type Rep CreateBasePathMapping :: * -> * # Methods from :: CreateBasePathMapping -> Rep CreateBasePathMapping x # to :: Rep CreateBasePathMapping x -> CreateBasePathMapping #
Hashable CreateBasePathMapping #
Instance details Defined in Network.AWS.APIGateway.CreateBasePathMapping Methods hashWithSalt :: Int -> CreateBasePathMapping -> Int # hash :: CreateBasePathMapping -> Int #
ToJSON CreateBasePathMapping #
Instance details Defined in Network.AWS.APIGateway.CreateBasePathMapping Methods toJSON :: CreateBasePathMapping -> Value # toEncoding :: CreateBasePathMapping -> Encoding # toJSONList :: [CreateBasePathMapping] -> Value # toEncodingList :: [CreateBasePathMapping] -> Encoding #
AWSRequest CreateBasePathMapping #
Instance details Defined in Network.AWS.APIGateway.CreateBasePathMapping Associated Types type Rs CreateBasePathMapping :: * # Methods request :: CreateBasePathMapping -> Request CreateBasePathMapping # response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy CreateBasePathMapping -> ClientResponse -> m (Response CreateBasePathMapping) #
ToHeaders CreateBasePathMapping #
Instance details Defined in Network.AWS.APIGateway.CreateBasePathMapping Methods toHeaders :: CreateBasePathMapping -> [Header] #
ToPath CreateBasePathMapping #
Instance details Defined in Network.AWS.APIGateway.CreateBasePathMapping Methods toPath :: CreateBasePathMapping -> ByteString #
ToQuery CreateBasePathMapping #
Instance details Defined in Network.AWS.APIGateway.CreateBasePathMapping Methods toQuery :: CreateBasePathMapping -> QueryString #
NFData CreateBasePathMapping #
Instance details Defined in Network.AWS.APIGateway.CreateBasePathMapping Methods rnf :: CreateBasePathMapping -> () #
type Rep CreateBasePathMapping #
Instance details Defined in Network.AWS.APIGateway.CreateBasePathMapping type Rep CreateBasePathMapping = D1 (MetaData "CreateBasePathMapping" "Network.AWS.APIGateway.CreateBasePathMapping" "amazonka-apigateway-1.6.0-AZknipQenWKIkkS1rcDzK1" False) (C1 (MetaCons "CreateBasePathMapping'" PrefixI True) ((S1 (MetaSel (Just "_cbpmStage") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_cbpmBasePath") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :: (S1 (MetaSel (Just "_cbpmDomainName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_cbpmRestAPIId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))
type Rs CreateBasePathMapping #
Instance details Defined in Network.AWS.APIGateway.CreateBasePathMapping type Rs CreateBasePathMapping = BasePathMapping

Request Lenses

cbpmStage :: Lens' CreateBasePathMapping (Maybe Text) #

The name of the API's stage that you want to use for this mapping. Leave this blank if you do not want callers to explicitly specify the stage name after any base path name.

cbpmBasePath :: Lens' CreateBasePathMapping (Maybe Text) #

The base path name that callers of the API must provide as part of the URL after the domain name. This value must be unique for all of the mappings across a single API. Leave this blank if you do not want callers to specify a base path name after the domain name.

cbpmDomainName :: Lens' CreateBasePathMapping Text #

Required: The domain name of the BasePathMapping resource to create.

cbpmRestAPIId :: Lens' CreateBasePathMapping Text #

Required: The string identifier of the associated RestApi .

Destructuring the Response

basePathMapping :: BasePathMapping #

Creates a value of BasePathMapping with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

bpmStage - The name of the associated stage.
bpmBasePath - The base path name that callers of the API must provide as part of the URL after the domain name.
bpmRestAPIId - The string identifier of the associated RestApi .

data BasePathMapping #

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: basePathMapping smart constructor.

Instances

Eq BasePathMapping #
Instance details Defined in Network.AWS.APIGateway.Types.Product Methods (==) :: BasePathMapping -> BasePathMapping -> Bool # (/=) :: BasePathMapping -> BasePathMapping -> Bool #
Data BasePathMapping #
Instance details Defined in Network.AWS.APIGateway.Types.Product Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> BasePathMapping -> c BasePathMapping # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c BasePathMapping # toConstr :: BasePathMapping -> Constr # dataTypeOf :: BasePathMapping -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c BasePathMapping) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c BasePathMapping) # gmapT :: (forall b. Data b => b -> b) -> BasePathMapping -> BasePathMapping # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> BasePathMapping -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> BasePathMapping -> r # gmapQ :: (forall d. Data d => d -> u) -> BasePathMapping -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> BasePathMapping -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> BasePathMapping -> m BasePathMapping # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> BasePathMapping -> m BasePathMapping # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> BasePathMapping -> m BasePathMapping #
Read BasePathMapping #
Instance details Defined in Network.AWS.APIGateway.Types.Product Methods readsPrec :: Int -> ReadS BasePathMapping # readList :: ReadS [BasePathMapping] # readPrec :: ReadPrec BasePathMapping # readListPrec :: ReadPrec [BasePathMapping] #
Show BasePathMapping #
Instance details Defined in Network.AWS.APIGateway.Types.Product Methods showsPrec :: Int -> BasePathMapping -> ShowS # show :: BasePathMapping -> String # showList :: [BasePathMapping] -> ShowS #
Generic BasePathMapping #
Instance details Defined in Network.AWS.APIGateway.Types.Product Associated Types type Rep BasePathMapping :: * -> * # Methods from :: BasePathMapping -> Rep BasePathMapping x # to :: Rep BasePathMapping x -> BasePathMapping #
Hashable BasePathMapping #
Instance details Defined in Network.AWS.APIGateway.Types.Product Methods hashWithSalt :: Int -> BasePathMapping -> Int # hash :: BasePathMapping -> Int #
FromJSON BasePathMapping #
Instance details Defined in Network.AWS.APIGateway.Types.Product Methods parseJSON :: Value -> Parser BasePathMapping # parseJSONList :: Value -> Parser [BasePathMapping] #
NFData BasePathMapping #
Instance details Defined in Network.AWS.APIGateway.Types.Product Methods rnf :: BasePathMapping -> () #
type Rep BasePathMapping #
Instance details Defined in Network.AWS.APIGateway.Types.Product type Rep BasePathMapping = D1 (MetaData "BasePathMapping" "Network.AWS.APIGateway.Types.Product" "amazonka-apigateway-1.6.0-AZknipQenWKIkkS1rcDzK1" False) (C1 (MetaCons "BasePathMapping'" PrefixI True) (S1 (MetaSel (Just "_bpmStage") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: (S1 (MetaSel (Just "_bpmBasePath") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_bpmRestAPIId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))

Response Lenses

bpmStage :: Lens' BasePathMapping (Maybe Text) #

The name of the associated stage.

bpmBasePath :: Lens' BasePathMapping (Maybe Text) #

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

bpmRestAPIId :: Lens' BasePathMapping (Maybe Text) #

The string identifier of the associated RestApi .