登录控制台
AWS CloudFormation
User Guide (API 版本 2010-05-15)
AWS 文档 » AWS CloudFormation » User Guide » 模板参考 » 资源属性类型参考 » Amazon API Gateway DocumentationPart Location
AWS 文档中描述的 AWS 服务或功能可能因区域而异。要查看适用于中国区域的差异，请参阅中国的 AWS 服务入门。

Amazon API Gateway DocumentationPart Location

Location 属性指定文档适用于的 Amazon API Gateway API 实体的位置。Location 是 AWS::ApiGateway::DocumentationPart 资源的一个属性。

语法

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

JSON

{
  "Method" : String,
  "Name" : String,
  "Path" : String,
  "StatusCode" : String,
  "Type" : String
}

YAML

Method: String
Name: String
Path: String
StatusCode: String
Type: String

属性

注意

有关每个属性的更多信息，包括约束和有效值，请参阅 Amazon API Gateway REST API 参考 中的 DocumentationPart。

Method

方法的 HTTP 动词。

必需：否

类型：字符串

更新要求：替换

Name

目标 API 实体的名称。

必需：否

类型：字符串

更新要求：替换

Path

目标的 URL 路径。

必需：否

类型：字符串

更新要求：替换

StatusCode

响应的 HTTP 状态代码。

必需：否

类型：字符串

更新要求：替换

Type

文档内容适用于的 API 实体的类型。

必需：否

类型：字符串

更新要求：替换

本页内容：