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

AWS::AppSync::GraphQLApi

AWS::AppSync::GraphQLApi 资源创建新的 AppSync GraphQL API。这是应用程序的顶级结构。有关更多信息,请参阅 AWS AppSync 开发人员指南 中的快速入门

语法

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

JSON

{ "Type" : "AWS::AppSync::GraphQLApi", "Properties" : { "AdditionalAuthenticationProviders" : AdditionalAuthenticationProviders, "AuthenticationType" : String, "LogConfig" : LogConfig, "Name" : String, "OpenIDConnectConfig" : OpenIDConnectConfig, "Tags" : Tags, "UserPoolConfig" : UserPoolConfig, "XrayEnabled" : Boolean } }

属性

AdditionalAuthenticationProviders

GraphqlApi API 的其他身份验证提供商的列表。

必需:否

类型AdditionalAuthenticationProviders

Update requires: No interruption

AuthenticationType

您的 GraphQL API 的安全配置。有关允许的值(例如 API_KEYAWS_IAMAMAZON_COGNITO_USER_POOLSOPENID_CONNECT),请参阅 AWS AppSync 开发人员指南 中的安全性

必需:是

类型:字符串

Update requires: No interruption

LogConfig

Amazon CloudWatch Logs 配置。

必需:否

类型LogConfig

Update requires: No interruption

Name

API 名称。

必需:是

类型:字符串

Update requires: No interruption

OpenIDConnectConfig

OpenID Connect 配置。

必需:否

类型OpenIDConnectConfig

Update requires: No interruption

Tags

此 GraphQL API 的任意标签组(键/值对)。

必需:否

类型Tags

Update requires: No interruption

UserPoolConfig

将 Amazon Cognito 用户池用于您的 GraphQL 终端节点的可选授权配置。

必需:否

类型UserPoolConfig

Update requires: No interruption

XrayEnabled

表示是否为此 GraphqlApi 启用 X-Ray 跟踪的标志。

必需:否

类型:布尔值

Update requires: No interruption

返回值

Ref

如果将 AWS::AppSync::GraphQLApi 资源的逻辑 ID 传递给内部 Ref 函数,则此函数将返回 GraphQL API 的 ARN,如 arn:aws:appsync:us-east-1:123456789012:apis/graphqlapiid

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

Fn::GetAtt

Fn::GetAtt 返回一个此类型指定属性的值。以下为可用属性和示例返回值。

有关使用 Fn::GetAtt 的更多信息,请参阅 Fn::GetAtt

ApiId

唯一的 AWS AppSync GraphQL API 标识符。

Arn

API 键的 Amazon 资源名称 (ARN),如 arn:aws:appsync:us-east-1:123456789012:apis/graphqlapiid

GraphQLUrl

您的 GraphQL API 的终端节点 URL。

示例

GraphQL API 创建示例

以下示例创建一个 GraphQL API。

YAML

Parameters: graphQlApiName: Type: String userPoolId: Type: String userPoolAwsRegion: Type: String defaultAction: Type: String Resources: GraphQLApi: Type: AWS::AppSync::GraphQLApi Properties: Name: Ref: graphQlApiName AuthenticationType: "AMAZON_COGNITO_USER_POOLS" UserPoolConfig: UserPoolId: Ref: userPoolId AwsRegion: Ref: userPoolAwsRegion DefaultAction: Ref: defaultAction

JSON

{ "Parameters": { "graphQlApiName": { "Type": "String" }, "userPoolId": { "Type": "String" }, "userPoolAwsRegion": { "Type": "String" }, "defaultAction": { "Type": "String" } }, "Resources": { "GraphQLApi": { "Type": "AWS::AppSync::GraphQLApi", "Properties": { "Name": { "Ref": "graphQlApiName" }, "AuthenticationType": "AMAZON_COGNITO_USER_POOLS", "UserPoolConfig": { "UserPoolId": { "Ref": "userPoolId" }, "AwsRegion": { "Ref": "userPoolAwsRegion" }, "DefaultAction": { "Ref": "defaultAction" } } } } } }

另请参阅