| Copyright | (c) 2013-2015 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
| Language | Haskell2010 |
Network.AWS.APIGateway.CreateBasePathMapping
Description
Creates a new BasePathMapping resource.
See: AWS API Reference for CreateBasePathMapping.
- createBasePathMapping :: Text -> Text -> CreateBasePathMapping
- data CreateBasePathMapping
- cbpmStage :: Lens' CreateBasePathMapping (Maybe Text)
- cbpmBasePath :: Lens' CreateBasePathMapping (Maybe Text)
- cbpmDomainName :: Lens' CreateBasePathMapping Text
- cbpmRestAPIId :: Lens' CreateBasePathMapping Text
- basePathMapping :: BasePathMapping
- data BasePathMapping
- bpmStage :: Lens' BasePathMapping (Maybe Text)
- bpmBasePath :: Lens' BasePathMapping (Maybe Text)
- bpmRestAPIId :: Lens' BasePathMapping (Maybe Text)
Creating a Request
Arguments
| :: Text | |
| -> Text | |
| -> 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:
data CreateBasePathMapping Source
Requests Amazon API Gateway to create a new BasePathMapping resource.
See: createBasePathMapping smart constructor.
Instances
Request Lenses
cbpmStage :: Lens' CreateBasePathMapping (Maybe Text) Source
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) 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. Leave this blank if you do not want callers to specify a base path name after the domain name.
cbpmDomainName :: Lens' CreateBasePathMapping Text Source
The domain name of the BasePathMapping resource to create.
cbpmRestAPIId :: Lens' CreateBasePathMapping Text Source
The name of the API that you want to apply this mapping to.
Destructuring the Response
basePathMapping :: BasePathMapping Source
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:
data BasePathMapping Source
Represents the base path that callers of the API that must provide as part of the URL after the domain name.
See: basePathMapping smart constructor.
Response Lenses
bpmBasePath :: 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.
bpmRestAPIId :: Lens' BasePathMapping (Maybe Text) Source
The name of the API.