AWS::ApiGateway::DocumentationPart Location
Location
属性指定文档适用于的 Amazon API Gateway API 实体的位置。Location
是 AWS:: ApiGateway:: DocumentationPart 资源的一个属性。
有关每个属性的更多信息,包括约束和有效值,请参阅 Amazon API Gateway REST API 参考中的 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
属性
Method
-
方法的 HTTP 动词。
必需:否
类型:字符串
Update requires: Replacement
Name
-
目标 API 实体的名称。
必需:否
类型:字符串
Update requires: Replacement
Path
-
目标的 URL 路径。
必需:否
类型:字符串
Update requires: Replacement
StatusCode
-
响应的 HTTP 状态代码。
必需:否
类型:字符串
Update requires: Replacement
Type
-
文档内容适用于的 API 实体的类型。
必需:否
类型:字符串
Update requires: Replacement
另请参阅
-
Amazon API Gateway REST API 参考中的 DocumentationPart