AWS::ApiGateway::BasePathMapping
The AWS::ApiGateway::BasePathMapping resource creates a base path that clients who call your Amazon API Gateway API must
use in the invocation URL.
Topics
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{ "Type" : "AWS::ApiGateway::BasePathMapping", "Properties" : { "BasePath" :String, "DomainName" :String, "RestApiId" :String, "Stage" :String} }
YAML
Type: AWS::ApiGateway::BasePathMapping Properties: BasePath:StringDomainName:StringRestApiId:StringStage:String
Properties
BasePath-
The base path name that callers of the API must provide in the URL after the domain name. If you specify this property, it can't be an empty string.
Required: No
Type: String
Update requires: Replacement
DomainName-
The domain name of a
DomainNameresource.Required: Yes
Type: String
Update requires: Replacement
RestApiId-
The name of the API.
Required: Yes
Type: String
Update requires: No interruption
Stage-
The name of the API's stage.
Required: No
Type: String
Update requires: No interruption
