AWS::Serverless::GraphQLApi

AWS Serverless Application Model （AWS SAM) AWS::Serverless::GraphQLApiリソースタイプを使用して、サーバーレスアプリケーションの API AWS AppSync GraphQLを作成および設定します。

の詳細については AWS AppSync、「 AWS AppSync デベロッパーガイド」の「とは AWS AppSync」を参照してください。

構文

YAML


LogicalId:
  Type: AWS::Serverless::GraphQLApi
  Properties:
    ApiKeys: ApiKeys
    Auth: Auth
    Cache: AWS::AppSync::ApiCache
    DataSources: DataSource
    DomainName: AWS::AppSync::DomainName
    Functions: Function
    Logging: LogConfig
    Name: String
    Resolvers: Resolver
    SchemaInline: String
    SchemaUri: String
    Tags:
    - Tag
    XrayEnabled: Boolean

プロパティ

ApiKeys

API キーを必要とする GraphQL オペレーションを実行するために使用できる一意のキーを作成します。

タイプ： ApiKeys

必須: いいえ

AWS CloudFormation 互換性: このプロパティはに固有 AWS SAM であり、 AWS CloudFormation 同等のプロパティはありません。

Auth

GraphQL API の認証を設定します。

タイプ: Auth

必須: はい

AWS CloudFormation 互換性: このプロパティはに固有 AWS SAM であり、 AWS CloudFormation 同等のプロパティはありません。

Cache

CreateApiCache 操作の入力です。

タイプ： AWS::AppSync::ApiCache

必須: いいえ

AWS CloudFormation 互換性： このプロパティは AWS::AppSync::ApiCacheリソースに直接渡されます。

DataSources

関数がに接続 AWS AppSync するためのデータソースを作成します。は Amazon DynamoDB と AWS Lambda データソース AWS SAM をサポートします。

タイプ： DataSource

必須: はい

AWS CloudFormation 互換性: このプロパティはに固有 AWS SAM であり、 AWS CloudFormation 同等のプロパティはありません。

DomainName

GraphQL API のカスタムドメイン名です。

タイプ： AWS::AppSync::DomainName

必須: いいえ

AWS CloudFormation 互換性: このプロパティは AWS::AppSync::DomainName resource に直接渡されます。はAWS::AppSync::DomainNameApiAssociationリソース AWS SAM を自動的に生成します。

Functions

特定のオペレーションを実行するように GraphQL API の関数を設定します。

タイプ: Function

必須: はい

AWS CloudFormation 互換性: このプロパティはに固有 AWS SAM であり、 AWS CloudFormation 同等のプロパティはありません。

Logging

GraphQL API の Amazon CloudWatch ログ記録を設定します。

このプロパティを指定しない場合、 AWS SAM は次の値を生成CloudWatchLogsRoleArnして設定します。

ExcludeVerboseContent: true
FieldLogLevel: ALL

ロギングをオプトアウトするには、以下を指定します。


Logging: false

タイプ： LogConfig

必須: いいえ

AWS CloudFormation 互換性: このプロパティは、 AWS::AppSync::GraphQLApiリソースの LogConfigプロパティに直接渡されます。

LogicalId

GraphQL API の一意の名前です。

タイプ: 文字列

必須: はい

AWS CloudFormation 互換性: このプロパティは、 AWS::AppSync::GraphQLApiリソースの Nameプロパティに直接渡されます。

Name

GraphQL API の名前です。このプロパティを指定して、LogicalId 値を上書きします。

タイプ: 文字列

必須: いいえ

AWS CloudFormation 互換性: このプロパティは、 AWS::AppSync::GraphQLApiリソースの Nameプロパティに直接渡されます。

Resolvers

GraphQL API のフィールドのリゾルバーを設定します。 AWS SAM は、JavaScript パイプラインリゾルバーをサポートします。

タイプ: Resolver

必須: はい

AWS CloudFormation 互換性: このプロパティはに固有 AWS SAM であり、 AWS CloudFormation 同等のプロパティはありません。

SchemaInline

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

タイプ: 文字列

必須: 条件的。SchemaInline または SchemaUri を指定する必要があります。

AWS CloudFormation 互換性: このプロパティは、 AWS::AppSync::GraphQLSchemaリソースの Definitionプロパティに直接渡されます。

SchemaUri

スキーマの Amazon Simple Storage Service (Amazon S3) バケット URI、またはローカルフォルダへのパスです。

ローカルフォルダへのパスを指定する場合、 AWS CloudFormation はデプロイ前にファイルを最初に Amazon S3 にアップロードする必要があります。 AWS SAM CLI を使用することで、この処理を円滑化することができます。詳細については、「その方法は? AWS SAM はデプロイ時にローカルファイルをアップロードします」を参照してください。

タイプ: 文字列

必須: 条件的。SchemaInline または SchemaUri を指定する必要があります。

AWS CloudFormation 互換性: このプロパティは、 AWS::AppSync::GraphQLSchemaリソースの DefinitionS3Locationプロパティに直接渡されます。

Tags

この GraphQL API のタグ (キーと値のペア)。タグを使用して、リソースを識別し、カテゴリー分類します。

タイプ: Tag のリスト

必須: いいえ

AWS CloudFormation 互換性: このプロパティは、 AWS::AppSync::GraphQLApiリソースの Tagプロパティに直接渡されます。

XrayEnabled

このリソースに AWS X-Ray トレーシングを使用するかどうかを指定します。

タイプ: ブール

必須: いいえ

AWS CloudFormation 互換性: このプロパティは、 AWS::AppSync::GraphQLApiリソースの XrayEnabledプロパティに直接渡されます。

例

DynamoDB データソースを使用する GraphQL API

この例では、DynamoDB テーブルをデータソースとして使用する GraphQL API を作成します。

schema.graphql


schema {
  query: Query
  mutation: Mutation
}

type Query {
  getPost(id: String!): Post
}

type Mutation {
  addPost(author: String!, title: String!, content: String!): Post!
}

type Post {
  id: String!
  author: String
  title: String
  content: String
  ups: Int!
  downs: Int!
  version: Int!
}

template.yaml


AWSTemplateFormatVersion: '2010-09-09'
Transform: AWS::Serverless-2016-10-31
...
Resources:
  DynamoDBPostsTable:
    Type: AWS::Serverless::SimpleTable

  MyGraphQLAPI:
    Type: AWS::Serverless::GraphQLApi
    Properties:
      SchemaUri: ./sam_graphql_api/schema.graphql
      Auth:
        Type: AWS_IAM
      DataSources:
        DynamoDb:
          PostsDataSource:
            TableName: !Ref DynamoDBPostsTable
            TableArn: !GetAtt DynamoDBPostsTable.Arn
      Functions:
        preprocessPostItem:
          Runtime:
            Name: APPSYNC_JS
            Version: 1.0.0
          DataSource: NONE
          CodeUri: ./sam_graphql_api/preprocessPostItem.js
        createPostItem:
          Runtime:
            Name: APPSYNC_JS
            Version: "1.0.0"
          DataSource: PostsDataSource
          CodeUri: ./sam_graphql_api/createPostItem.js
        getPostFromTable:
          Runtime:
            Name: APPSYNC_JS
            Version: "1.0.0"
          DataSource: PostsDataSource
          CodeUri: ./sam_graphql_api/getPostFromTable.js
      Resolvers:
        Mutation:
          addPost:
            Runtime:
              Name: APPSYNC_JS
              Version: "1.0.0"
            Pipeline:
            - preprocessPostItem
            - createPostItem
        Query:
          getPost:
            CodeUri: ./sam_graphql_api/getPost.js
            Runtime:
              Name: APPSYNC_JS
              Version: "1.0.0"
            Pipeline:
            - getPostFromTable

createPostItem.js


import { util } from "@aws-appsync/utils";

export function request(ctx) {
  const { key, values } = ctx.prev.result;
  return {
    operation: "PutItem",
    key: util.dynamodb.toMapValues(key),
    attributeValues: util.dynamodb.toMapValues(values),
  };
}

export function response(ctx) {
  return ctx.result;
}

getPostFromTable.js


import { util } from "@aws-appsync/utils";

export function request(ctx) {
  return dynamoDBGetItemRequest({ id: ctx.args.id });
}

export function response(ctx) {
  return ctx.result;
}

/**
 * A helper function to get a DynamoDB item
 */
function dynamoDBGetItemRequest(key) {
  return {
    operation: "GetItem",
    key: util.dynamodb.toMapValues(key),
  };
}

preprocessPostItem.js


import { util } from "@aws-appsync/utils";

export function request(ctx) {
  const id = util.autoId();
  const { ...values } = ctx.args;
  values.ups = 1;
  values.downs = 0;
  values.version = 1;
  return { payload: { key: { id }, values: values } };
}

export function response(ctx) {
  return ctx.result;
}

リゾルバーコードは以下のとおりです。

getPost.js


export function request(ctx) {
  return {};
}

export function response(ctx) {
  return ctx.prev.result;
}

データソースとして Lambda 関数を使用する GraphQL API

この例では、Lambda 関数をデータソースとして使用する GraphQL API を作成します。

template.yaml


AWSTemplateFormatVersion: '2010-09-09'
Transform: AWS::Serverless-2016-10-31
...
Resources:
  MyLambdaFunction:
    Type: AWS::Serverless::Function
    Properties:
      Handler: index.handler
      Runtime: nodejs20.x
      CodeUri: ./lambda

  MyGraphQLAPI:
    Type: AWS::Serverless::GraphQLApi
    Properties:
      Name: MyApi
      SchemaUri: ./gql/schema.gql
      Auth:
        Type: API_KEY
      ApiKeys:
        MyApiKey:
          Description: my api key
      DataSources:
        Lambda:
          MyLambdaDataSource:
            FunctionArn: !GetAtt MyLambdaFunction.Arn
      Functions:
        lambdaInvoker:
          Runtime:
            Name: APPSYNC_JS
            Version: 1.0.0
          DataSource: MyLambdaDataSource
          CodeUri: ./gql/invoker.js
      Resolvers:
        Mutation:
          addPost:
            Runtime:
              Name: APPSYNC_JS
              Version: 1.0.0
            Pipeline:
            - lambdaInvoker
        Query:
          getPost:
            Runtime:
              Name: APPSYNC_JS
              Version: 1.0.0
            Pipeline:
            - lambdaInvoker

Outputs:
  MyGraphQLAPI:
    Description: AppSync API
    Value: !GetAtt MyGraphQLAPI.GraphQLUrl
  MyGraphQLAPIMyApiKey:
    Description: API Key for authentication
    Value: !GetAtt MyGraphQLAPIMyApiKey.ApiKey

schema.graphql


schema {
  query: Query
  mutation: Mutation
}
type Query {
  getPost(id: ID!): Post
}
type Mutation {
  addPost(id: ID!, author: String!, title: String, content: String): Post!
}
type Post {
  id: ID!
  author: String!
  title: String
  content: String
  ups: Int
  downs: Int
}

関数は次のとおりです。

lambda/index.js


exports.handler = async (event) => {
  console.log("Received event {}", JSON.stringify(event, 3));

  const posts = {
    1: {
      id: "1",
      title: "First book",
      author: "Author1",
      content: "Book 1 has this content",
      ups: "100",
      downs: "10",
    },
  };

  console.log("Got an Invoke Request.");
  let result;
  switch (event.field) {
    case "getPost":
      return posts[event.arguments.id];
    case "addPost":
      // return the arguments back
      return event.arguments;
    default:
      throw new Error("Unknown field, unable to resolve " + event.field);
  }
};

invoker.js


import { util } from "@aws-appsync/utils";

export function request(ctx) {
  const { source, args } = ctx;
  return {
    operation: "Invoke",
    payload: { field: ctx.info.fieldName, arguments: args, source },
  };
}

export function response(ctx) {
  return ctx.result;
}

ブラウザで JavaScript が無効になっているか、使用できません。

AWS ドキュメントを使用するには、JavaScript を有効にする必要があります。手順については、使用するブラウザのヘルプページを参照してください。

ドキュメントの表記規則

FunctionUrlConfig

ApiKeys