AWS CloudFormation
ユーザーガイド (API バージョン 2010-05-15)

AWS::AppSync::GraphQLSchema

AWS::AppSync::GraphQLSchema リソースは、API のデータモデルを制御する AWS AppSync GraphQL スキーマで使用されます。スキーマファイルは、スキーマ定義言語 (SDL) 形式で書き込まれたテキストです。スキーマ作成については、「GraphQL API の指定」を参照してください。

構文

AWS CloudFormation テンプレートでこのエンティティを宣言するには、次の構文を使用します。

JSON

{ "Type" : "AWS::AppSync::GraphQLSchema", "Properties" : { "Definition" : String, "DefinitionS3Location" : String, "ApiId" : String } }

YAML

Type: "AWS::AppSync::GraphQLSchema" Properties: Definition: String DefinitionS3Location: String ApiId: String

プロパティ

Definition

SDL 形式の GraphQL スキーマをテキストで表記したものです。

必須: いいえ

タイプ: 文字列

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

DefinitionS3Location

CloudFormation テンプレートに組み込まずに、S3 上のスキーマを使用してプロビジョニングする場合の S3 バケット上の GraphQL スキーマファイルの位置。

必須: いいえ

タイプ: 文字列

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

ApiId

このスキーマを適用する AWS AppSync GraphQL API 識別子。

必須: はい

タイプ: 文字列

更新に伴う要件: 置換

戻り値

参照番号

AWS::AppSync::GraphQLSchema リソースの論理 ID を組み込み Ref 関数に渡すと、アタッチされているリテラル文字列 GraphQLSchema を含む GraphQL API ID が返ります。

Ref 関数の使用方法の詳細については、「Ref」を参照してください。

GraphQL スキーマの作成例

次の例では、GraphQL スキーマを作成して、パラメータとして GraphQL API ID を渡し、既存の GraphQL API と関連付けます。

JSON

{ "Parameters": { "graphQlApiId": { "Type": "String" }, "graphQlSchemaS3DescriptionLocation": { "Type": "String" } }, "Resources": { "Schema": { "Type": "AWS::AppSync::GraphQLSchema", "Properties": { "ApiId": { "Ref": "graphQlApiId" }, "DefinitionS3Location": { "Ref": "graphQlSchemaS3DescriptionLocation" } } } } }

YAML

Parameters: graphQlApiId: Type: String graphQlSchemaS3DescriptionLocation: Type: String Resources: Schema: Type: AWS::AppSync::GraphQLSchema Properties: ApiId: Ref: graphQlApiId DefinitionS3Location: Ref: graphQlSchemaS3DescriptionLocation

以下の資料も参照してください。