Skip to content

CreateBasePathMappingRequest

Source code in docs_src/capo_api_gateway/types/create_base_path_mapping_request.py 
13
14
15
16
17
18
19
20
21
22
23
class CreateBasePathMappingRequest(TypedDict, closed=True):
    domain_name: "capo_api_gateway.types.string.String"
    """<p>The domain name of the BasePathMapping resource to create.</p>"""
    domain_name_id: NotRequired["capo_api_gateway.types.string.String"]
    """<p>The identifier for the domain name resource. Required for private custom domain names.</p>"""
    base_path: NotRequired["capo_api_gateway.types.string.String"]
    """<p>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.</p>"""
    rest_api_id: "capo_api_gateway.types.string.String"
    """<p>The string identifier of the associated RestApi.</p>"""
    stage: NotRequired["capo_api_gateway.types.string.String"]
    """<p>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.</p>"""

base_path instance-attribute 

base_path: NotRequired[String]

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.

domain_name instance-attribute 

domain_name: String

The domain name of the BasePathMapping resource to create.

domain_name_id instance-attribute 

domain_name_id: NotRequired[String]

The identifier for the domain name resource. Required for private custom domain names.

rest_api_id instance-attribute 

rest_api_id: String

The string identifier of the associated RestApi.

stage instance-attribute 

stage: NotRequired[String]

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.