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.APIGateway.CreateBasePathMapping

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a new BasePathMapping resource.

Creating a Request

data CreateBasePathMapping Source #

Requests API Gateway to create a new BasePathMapping resource.

See: newCreateBasePathMapping smart constructor.

Constructors

CreateBasePathMapping'

Fields

basePath :: 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. Specify '(none)' if you do not want callers to specify a base path name after the domain name.
stage :: Maybe Text
The name of the API's stage that you want to use for this mapping. Specify '(none)' if you want callers to explicitly specify the stage name after any base path name.
domainName :: Text
The domain name of the BasePathMapping resource to create.
restApiId :: Text
The string identifier of the associated RestApi.

Instances

Instances details

ToJSON CreateBasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.CreateBasePathMapping Methods toJSON :: CreateBasePathMapping -> Value # toEncoding :: CreateBasePathMapping -> Encoding # toJSONList :: [CreateBasePathMapping] -> Value # toEncodingList :: [CreateBasePathMapping] -> Encoding #
ToHeaders CreateBasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.CreateBasePathMapping Methods toHeaders :: CreateBasePathMapping -> [Header] #
ToPath CreateBasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.CreateBasePathMapping Methods toPath :: CreateBasePathMapping -> ByteString #
ToQuery CreateBasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.CreateBasePathMapping Methods toQuery :: CreateBasePathMapping -> QueryString #
AWSRequest CreateBasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.CreateBasePathMapping Associated Types type AWSResponse CreateBasePathMapping # Methods request :: (Service -> Service) -> CreateBasePathMapping -> Request CreateBasePathMapping # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateBasePathMapping -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateBasePathMapping))) #
Generic CreateBasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.CreateBasePathMapping Associated Types type Rep CreateBasePathMapping :: Type -> Type # Methods from :: CreateBasePathMapping -> Rep CreateBasePathMapping x # to :: Rep CreateBasePathMapping x -> CreateBasePathMapping #
Read CreateBasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.CreateBasePathMapping Methods readsPrec :: Int -> ReadS CreateBasePathMapping # readList :: ReadS [CreateBasePathMapping] # readPrec :: ReadPrec CreateBasePathMapping # readListPrec :: ReadPrec [CreateBasePathMapping] #
Show CreateBasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.CreateBasePathMapping Methods showsPrec :: Int -> CreateBasePathMapping -> ShowS # show :: CreateBasePathMapping -> String # showList :: [CreateBasePathMapping] -> ShowS #
NFData CreateBasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.CreateBasePathMapping Methods rnf :: CreateBasePathMapping -> () #
Eq CreateBasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.CreateBasePathMapping Methods (==) :: CreateBasePathMapping -> CreateBasePathMapping -> Bool # (/=) :: CreateBasePathMapping -> CreateBasePathMapping -> Bool #
Hashable CreateBasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.CreateBasePathMapping Methods hashWithSalt :: Int -> CreateBasePathMapping -> Int # hash :: CreateBasePathMapping -> Int #
type AWSResponse CreateBasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.CreateBasePathMapping type AWSResponse CreateBasePathMapping = BasePathMapping
type Rep CreateBasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.CreateBasePathMapping type Rep CreateBasePathMapping = D1 ('MetaData "CreateBasePathMapping" "Amazonka.APIGateway.CreateBasePathMapping" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "CreateBasePathMapping'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "basePath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "stage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "domainName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "restApiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newCreateBasePathMapping Source #

Arguments

:: Text	`CreateBasePathMapping`
-> Text	`CreateBasePathMapping`
-> CreateBasePathMapping

Create a value of CreateBasePathMapping 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:

CreateBasePathMapping, createBasePathMapping_basePath - 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. Specify '(none)' if you do not want callers to specify a base path name after the domain name.

CreateBasePathMapping, createBasePathMapping_stage - The name of the API's stage that you want to use for this mapping. Specify '(none)' if you want callers to explicitly specify the stage name after any base path name.

CreateBasePathMapping, createBasePathMapping_domainName - The domain name of the BasePathMapping resource to create.

CreateBasePathMapping, createBasePathMapping_restApiId - The string identifier of the associated RestApi.

Request Lenses

createBasePathMapping_basePath :: Lens' CreateBasePathMapping (Maybe Text) Source #

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. Specify '(none)' if you do not want callers to specify a base path name after the domain name.

createBasePathMapping_stage :: Lens' CreateBasePathMapping (Maybe Text) Source #

The name of the API's stage that you want to use for this mapping. Specify '(none)' if you want callers to explicitly specify the stage name after any base path name.

createBasePathMapping_domainName :: Lens' CreateBasePathMapping Text Source #

The domain name of the BasePathMapping resource to create.

createBasePathMapping_restApiId :: Lens' CreateBasePathMapping Text Source #

The string identifier of the associated RestApi.

Destructuring the Response

data BasePathMapping Source #

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

See: newBasePathMapping smart constructor.

Constructors

BasePathMapping'
Fields basePath :: Maybe Text The base path name that callers of the API must provide as part of the URL after the domain name. restApiId :: Maybe Text The string identifier of the associated RestApi. stage :: Maybe Text The name of the associated stage.

Instances

Instances details

FromJSON BasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.Types.BasePathMapping Methods parseJSON :: Value -> Parser BasePathMapping # parseJSONList :: Value -> Parser [BasePathMapping] #
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 #
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 #
NFData BasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.Types.BasePathMapping Methods rnf :: BasePathMapping -> () #
Eq BasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.Types.BasePathMapping Methods (==) :: BasePathMapping -> BasePathMapping -> Bool # (/=) :: BasePathMapping -> BasePathMapping -> Bool #
Hashable BasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.Types.BasePathMapping Methods hashWithSalt :: Int -> BasePathMapping -> Int # hash :: BasePathMapping -> Int #
type Rep BasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.Types.BasePathMapping type Rep BasePathMapping = D1 ('MetaData "BasePathMapping" "Amazonka.APIGateway.Types.BasePathMapping" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "BasePathMapping'" 'PrefixI 'True) (S1 ('MetaSel ('Just "basePath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "restApiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "stage") '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: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.

$sel:stage:BasePathMapping', basePathMapping_stage - The name of the associated stage.

Response Lenses

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.

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

The name of the associated stage.