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

AWS::ApiGateway::Model

AWS::ApiGateway::Model 资源定义 API 方法的请求或响应负载的结构。

语法

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

JSON

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

YAML

Type: AWS::ApiGateway::Model Properties: ContentType: String Description: String Name: String RestApiId: String Schema: Json

属性

ContentType

模型的内容类型。

必需:否

类型:字符串

Update requires: Replacement

Description

标识此模型的说明。

必需:否

类型:字符串

Update requires: No interruption

Name

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

重要

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

必需:否

类型:字符串

Update requires: Replacement

RestApiId

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

必需:是

类型:字符串

Update requires: Replacement

Schema

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

必需:否

类型:Json

Update requires: No interruption

返回值

Ref

在将此资源的逻辑 ID 传递给内部 Ref 函数时,Ref 返回 模型名称,例如 myModel

For more information about using the Ref function, see Ref.

示例

创建模型

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

JSON

{ "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

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

另请参阅