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

AWS::AppSync::GraphQLApi

AWS::AppSync::GraphQLApi リソースを使用して、新しい AWS AppSync GraphQL API を作成します。これは、アプリケーションのトップレベル構造体です。詳細については、「クイックスタートガイド」を参照してください。

構文

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

JSON

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

YAML

Type: "AWS::AppSync::GraphQLApi" Properties: UserPoolConfig: UserPoolConfig OpenIDConnectConfig : OpenIDConnectConfig Name: String AuthenticationType: String LogConfig: LogConfig

プロパティ

UserPoolConfig

GraphQL エンドポイントで Amazon Cognito ユーザープールを使用するオプションの認証設定。

必須: いいえ

タイプ: AWS AppSync GraphQLApi UserPoolConfig

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

OpenIDConnectConfig

GraphQL エンドポイントで OpenID Connect 準拠のサービスを使用するためのオプションの認証設定。

必須: いいえ

タイプ: AWS AppSync GraphQLApi OpenID Connect Config

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

Name

AWS AppSync の GraphQL API の分かりやすい名前。

必須: はい

タイプ: 文字列

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

AuthenticationType

GraphQL API のセキュリティ設定。指定できる値 (例: API_KEY、AWS_IAM、AMAZON_COGNITO_USER_POOLS、または OPENID_CONNECT) については、『AWS AppSync 開発者ガイド』の「セキュリティ」を参照してください。

必須: はい

タイプ: 文字列

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

LogConfig

GraphQL オペレーションを書き込み、Amazon Cloudwatch を追跡する場合のログ設定です。

必須: いいえ

タイプ: AWS AppSync GraphQLApi LogConfig

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

戻り値

参照番号

AWS::AppSync::GraphQLApi リソースの論理 ID を組み込み Ref 関数に渡すと、GraphQL API の ARN (例: arn:aws:appsync:us-east-1:123456789012:apis/graphqlapiid) が返ります。

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

Fn::GetAtt

Fn::GetAtt は、このタイプの指定された属性の値を返します。以下には、利用可能な属性とサンプル戻り値のリストが示されます。

GraphQLUrl

GraphQL API のエンドポイント URL。

Arn

API キーの Amazon リソースネーム (ARN) (例: arn:aws:appsync:us-east-1:123456789012:apis/graphqlapiid)。

ApiId

AWS AppSync の一意の GraphQL API 識別子です。

Fn::GetAtt の使用の詳細については、「Fn::GetAtt」を参照してください。

GraphQL API の作成例

以下の例では、GraphQL API を作成します。

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" } } } } } }

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

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

  • AWS AppSync API リファレンスCreateGraphqlApi オペレーション。