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

AWS::ApiGatewayV2::Model

AWS::ApiGatewayV2::Model 资源更新 WebSocket API 的数据模型。有关更多信息,请参阅 API Gateway 开发人员指南中的 模型选择表达式

语法

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

JSON

{ "Type" : "AWS::ApiGatewayV2::Model", "Properties" : { "ApiId" : String, "ContentType" : String, "Description" : String, "Name" : String, "Schema" : Json } }

YAML

Type: AWS::ApiGatewayV2::Model Properties: ApiId: String ContentType: String Description: String Name: String Schema: Json

属性

ApiId

API 标识符。

必需:是

类型:字符串

Update requires: Replacement

ContentType

模型的内容类型,例如“application/json”。

必需:否

类型:字符串

Update requires: No interruption

Description

模型的描述。

必需:否

类型:字符串

Update requires: No interruption

Name

模型的名称。

必需:是

类型:字符串

Update requires: No interruption

Schema

模型的架构。对于 application/json 模型,这应为 JSON 架构草稿 4 模型。

必需:是

类型:Json

Update requires: No interruption

返回值

Ref

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

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

示例

模型创建示例

以下示例创建一个名为 MyApi 的 API 创建一个名为 MyModelmodel 资源。

JSON

{ "MyModel": { "Type": "AWS::ApiGatewayV2::Model", "Properties": { "Name": "ModelName", "ApiId": { "Ref": "MyApi" }, "ContentType": "application/json", "Schema": { "$schema": "http://json-schema.org/draft-04/schema#", "title": "DummySchema", "type": "object", "properties": { "id": { "type": "string" } } } } } }

YAML

MyModel: Type: 'AWS::ApiGatewayV2::Model' Properties: Name: ModelName ApiId: !Ref MyApi ContentType: application/json Schema: $schema: 'http://json-schema.org/draft-04/schema#' title: DummySchema type: object properties: id: type: string

另请参阅

  • Amazon API Gateway 版本 2 API 参考中的 CreateModel