メニュー
AWS CloudFormation
ユーザーガイド (API Version 2010-05-15)

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 をモデル名として使用します。詳細については、「Name タイプ」を参照してください。

重要

名前を指定すると、このリソースの置換が必要な更新はできません。中断が不要であるか、一定の中断が必要な更新であれば、行うことができます。リソースを置き換える必要がある場合は、新しい名前を指定します。

Required: No

Type: String

更新に伴う要件: 置換

RestApiId

このモデルが関連付けられている REST API の ID。

Required: Yes

Type: String

更新に伴う要件: 置換

Schema

1 つまたは複数の形式にデータを変換するために使用するスキーマ。スキーマを指定しない場合は、null ({}) を指定します。

Required: Yes

Type: JSON object

更新に伴う要件: 中断はありません。

戻り値

参照番号

このリソースの論理 ID が Ref 組み込み関数に提供されると、Ref により myModel のようなモデル名が返されます。

Ref 関数の使用方法の詳細については、「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

このページの内容: