AWS CloudFormation
User Guide (Version )

AWS::ApiGateway::BasePathMapping

The AWS::ApiGateway::BasePathMapping resource creates a base path that clients who call your API must use in the invocation URL.

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: String DomainName: String RestApiId: String Stage: 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 DomainName of an AWS::ApiGateway::DomainName resource.

Required: Yes

Type: String

Update requires: Replacement

RestApiId

The name of the API.

Required: No

Type: String

Update requires: No interruption

Stage

The name of the API's stage.

Required: No

Type: String

Update requires: No interruption

See Also

On this page: