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 |
Creates a new BasePathMapping
resource.
Synopsis
- 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
createBasePathMapping Source #
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 theBasePathMapping
resource to create.cbpmRestAPIId
- [Required] The string identifier of the associatedRestApi
.
data CreateBasePathMapping Source #
Requests 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 #
- Required
- The domain name of the
BasePathMapping
resource to create.
cbpmRestAPIId :: Lens' CreateBasePathMapping Text Source #
- Required
- The string identifier of the associated
RestApi
.
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:
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 associatedRestApi
.
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: basePathMapping
smart constructor.
Instances
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 string identifier of the associated RestApi
.