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

AWS::ApiGateway::Model

AWS::ApiGateway::Model 资源定义 Amazon API Gateway (API 网关) 方法的请求或响应负载的结构。

语法

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

JSON

Copy
{ "Type" : "AWS::ApiGateway::Model", "Properties" : { "ContentType" : String, "Description" : String, "Name" : String, "RestApiId" : String, "Schema" : JSON object } }

YAML

Copy
Type: "AWS::ApiGateway::Model" Properties: ContentType: String Description: String Name: String RestApiId: String Schema: JSON object

属性

ContentType

模型的内容类型。

Required: Yes

Type: String

更新要求替换

Description

标识此模型的说明。

Required: No

Type: String

更新要求无需中断

Name

模型的名称。如果不指定名称,则 AWS CloudFormation 会生成一个唯一物理 ID 并将该 ID 用作模型名称。有关更多信息,请参阅 名称类型

重要

如果指定一个名称,您将无法执行需要替换此资源的更新。您可以执行不需要或者只需要部分中断的更新。如果必须替换资源,请指定新名称。

Required: No

Type: String

更新要求替换

RestApiId

用来与此模型关联的 REST API 的 ID。

Required: Yes

Type: String

更新要求替换

Schema

用于将数据转换为一个或多个输出格式的方案。如果您不想指定一个架构,请指定 null ({})。

Required: Yes

Type: JSON object

更新要求无需中断

返回值

Ref

当向 Ref 内部函数提供此资源的逻辑 ID 时,Ref 将返回模型名称,例如 myModel

有关使用 Ref 功能的更多信息,请参阅参考

示例

下面的示例创建将输入数据转换为所述方案的模型。

JSON

Copy
"PetsModelNoFlatten": { "Type": "AWS::ApiGateway::Model", "Properties": { "RestApiId": { "Ref": "RestApi" }, "ContentType": "application/json", "Description": "Schema for Pets example", "Name": "PetsModelNoFlatten", "Schema": { "$schema": "http://json-schema.org/draft-04/schema#", "title": "PetsModelNoFlatten", "type": "array", "items": { "type": "object", "properties": { "number": { "type": "integer" }, "class": { "type": "string" }, "salesPrice": { "type": "number" } } } } } }

YAML

Copy
PetsModelNoFlatten: Type: "AWS::ApiGateway::Model" Properties: RestApiId: Ref: RestApi ContentType: "application/json" Description: "Schema for Pets example" Name: PetsModelNoFlatten Schema: "$schema": "http://json-schema.org/draft-04/schema#" title: PetsModelNoFlatten type: array items: type: object properties: number: type: integer class: type: string salesPrice: type: number

本页内容: