AWS::ApiGateway::BasePathMapping - AWS CloudFormation
AWS 文档中描述的 AWS 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 AWS 服务入门

AWS::ApiGateway::BasePathMapping

AWS::ApiGateway::BasePathMapping 资源创建一个基本路径,调用 API 的客户端必须在调用 URL 中使用此路径。

语法

要在 AWS CloudFormation 模板中声明此实体,请使用以下语法:

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

属性

BasePath

API 调用方必须在 URL 中的域名后提供的基本路径名称。

必需:否

类型:字符串

Update requires: Replacement

DomainName

AWS::ApiGateway::DomainName 资源的 DomainName

必需:是

类型:字符串

Update requires: Replacement

RestApiId

API 的 ID。

必需:否

类型:字符串

Update requires: No interruption

Stage

API 的阶段的名称。

必需:否

类型:字符串

Update requires: No interruption

另请参阅