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

Description

Creates a new BasePathMapping resource.

Synopsis

Creating a Request

data CreateBasePathMapping Source #

Requests API Gateway to create a new BasePathMapping resource.

See: newCreateBasePathMapping smart constructor.

Constructors

CreateBasePathMapping' 

Fields

  • 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.

  • 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.

  • domainName :: Text
    Required
    The domain name of the BasePathMapping resource to create.
  • restApiId :: Text
    Required
    The string identifier of the associated RestApi.

Instances

Instances details
Eq CreateBasePathMapping Source # 
Instance details

Defined in Amazonka.APIGateway.CreateBasePathMapping

Methods

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

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

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 #

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 #

NFData CreateBasePathMapping Source # 
Instance details

Defined in Amazonka.APIGateway.CreateBasePathMapping

Methods

rnf :: CreateBasePathMapping -> () #

Hashable CreateBasePathMapping Source # 
Instance details

Defined in Amazonka.APIGateway.CreateBasePathMapping

Methods

hashWithSalt :: Int -> CreateBasePathMapping -> Int #

hash :: CreateBasePathMapping -> Int #

ToJSON CreateBasePathMapping Source # 
Instance details

Defined in Amazonka.APIGateway.CreateBasePathMapping

Methods

toJSON :: CreateBasePathMapping -> Value #

toEncoding :: CreateBasePathMapping -> Encoding #

toJSONList :: [CreateBasePathMapping] -> Value #

toEncodingList :: [CreateBasePathMapping] -> Encoding #

AWSRequest CreateBasePathMapping Source # 
Instance details

Defined in Amazonka.APIGateway.CreateBasePathMapping

Associated Types

type AWSResponse CreateBasePathMapping #

Methods

request :: CreateBasePathMapping -> Request CreateBasePathMapping #

response :: MonadResource m => Logger -> Service -> Proxy CreateBasePathMapping -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateBasePathMapping))) #

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 #

type Rep CreateBasePathMapping Source # 
Instance details

Defined in Amazonka.APIGateway.CreateBasePathMapping

type Rep CreateBasePathMapping = D1 ('MetaData "CreateBasePathMapping" "Amazonka.APIGateway.CreateBasePathMapping" "libZSservicesZSamazonka-apigatewayZSamazonka-apigateway" 'False) (C1 ('MetaCons "CreateBasePathMapping'" '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 "domainName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "restApiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse CreateBasePathMapping Source # 
Instance details

Defined in Amazonka.APIGateway.CreateBasePathMapping

type AWSResponse CreateBasePathMapping = BasePathMapping

newCreateBasePathMapping Source #

Arguments

:: Text

$sel:domainName:CreateBasePathMapping'

-> Text

$sel:restApiId: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:

$sel:stage: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.

$sel:basePath: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.

$sel:domainName:CreateBasePathMapping', createBasePathMapping_domainName - [Required] The domain name of the BasePathMapping resource to create.

$sel:restApiId:CreateBasePathMapping', createBasePathMapping_restApiId - [Required] The string identifier of the associated RestApi.

Request Lenses

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_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_domainName :: Lens' CreateBasePathMapping Text Source #

Required
The domain name of the BasePathMapping resource to create.

createBasePathMapping_restApiId :: Lens' CreateBasePathMapping Text Source #

Required
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.

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.

Response Lenses

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.