AWS CloudFormation
User Guide (API Version 2010-05-15)
AWS 服务或AWS文档中描述的功能,可能因地区/位置而异。请点击 Amazon AWS 入门,可查看中国地区的具体差异

AWS::ApiGateway::BasePathMapping

AWS::ApiGateway::BasePathMapping 资源创建一个基本路径,调用 Amazon API Gateway 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 中的域名后提供的基本路径名称。

Required: No

Type: String

更新要求替换

DomainName

DomainName 资源的名称。

Required: Yes

Type: String

更新要求替换

RestApiId

API 的名称。

Required: Yes

Type: String

更新要求无需中断

Stage

API 的阶段的名称。

Required: No

Type: String

更新要求无需中断

本页内容: