CmdID

CmdID / aws / aws apigateway

aws apigateway create-base-path-mapping

Creates a new BasePathMapping resource. AWS CLI reference

1 example 5 options Its page in the AWS CLI reference

Opens CmdID with your command. It is read in your browser and sent nowhere.

Examples

from aws-cli, each command read by CmdID

To create the base path mapping for a custom domain name

The following create-base-path-mapping example creates the base path mapping for a custom domain name.

aws apigateway create-base-path-mapping --domain-name subdomain.domain.tld --rest-api-id 1234123412 --stage prod --base-path v1Identify
--domain-nameThe domain name of the BasePathMapping resource to create.
--rest-api-idThe string identifier of the associated RestApi.
--stageThe name of the API's stage that you want to use for this mapping.
--base-pathThe base path name that callers of the API must provide as part of the URL after the domain name.
Its output
{
    "basePath": "v1",
    "restApiId": "1234123412",
    "stage": "prod"
}

For more information, see Custom domain name for public REST APIs in API Gateway in the Amazon API Gateway Developer Guide.

Options

5 in the AWS CLI reference
--base-pathThe base path name that callers of the API must provide as part of the URL after the domain name.
--domain-name-idThe identifier for the domain name resource.
--domain-nameThe domain name of the BasePathMapping resource to create.
--rest-api-idThe string identifier of the associated RestApi.
--stageThe name of the API's stage that you want to use for this mapping.