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

AWS::AppSync::GraphQLSchema

AWS::AppSync::GraphQLSchema 资源用于可控制 API 的数据模型的 AWS AppSync GraphQL 架构。架构文件是用架构定义语言 (SDL) 格式编写的文本。有关架构创作的更多信息,请参阅 AWS AppSync 开发人员指南 中的设计 GraphQL API

语法

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

JSON

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

YAML

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

属性

ApiId

要将此架构应用于的 AWS AppSync GraphQL API 标识符。

必需:是

类型:字符串

Update requires: Replacement

Definition

GraphQL 架构的 SDL 格式的文本表示。

有关使用 Ref 函数的更多信息,请参阅 Ref

必需:否

类型:字符串

Update requires: No interruption

DefinitionS3Location

GraphQL 架构文件在 Amazon S3 存储桶中的位置。如果要在 Amazon S3 中配置架构而不是将其嵌入 CloudFormation 模板中,请使用此项。

必需:否

类型:字符串

Update requires: No interruption

返回值

Ref

在将 AWS::AppSync::GraphQLSchema 资源的逻辑 ID 传递给内部 Ref 函数时,该函数将返回附加了文字字符串 GraphQLSchema 的 GraphQL API id。

有关使用 Ref 函数的更多信息,请参阅 Ref

示例

GraphQL 架构创建示例

以下示例创建一个 GraphQL 架构并通过将 GraphQL API ID 作为参数传递来将该架构与现有 GraphQL API 关联。

YAML

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

JSON

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

另请参阅