Copyright | (c) 2013-2017 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 |
Describe a BasePathMapping
resource.
- getBasePathMapping :: Text -> Text -> GetBasePathMapping
- data GetBasePathMapping
- gbpmDomainName :: Lens' GetBasePathMapping Text
- gbpmBasePath :: Lens' GetBasePathMapping Text
- basePathMapping :: BasePathMapping
- data BasePathMapping
- bpmStage :: Lens' BasePathMapping (Maybe Text)
- bpmBasePath :: Lens' BasePathMapping (Maybe Text)
- bpmRestAPIId :: Lens' BasePathMapping (Maybe Text)
Creating a Request
Creates a value of GetBasePathMapping
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
gbpmDomainName
- The domain name of theBasePathMapping
resource to be described.gbpmBasePath
- 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 any base path name after the domain name.
data GetBasePathMapping Source #
Request to describe a BasePathMapping
resource.
See: getBasePathMapping
smart constructor.
Request Lenses
gbpmDomainName :: Lens' GetBasePathMapping Text Source #
The domain name of the BasePathMapping
resource to be described.
gbpmBasePath :: Lens' GetBasePathMapping 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 any base path name after the domain name.
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.
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
.