機能

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

構文

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

YAML

LogicalId:
  CodeUri: String
  DataSource: String
  Description: String
  Id: String
  InlineCode: String
  MaxBatchSize: Integer
  Name: String
  Runtime: Runtime
  Sync: SyncConfig

プロパティ

CodeUri

関数コードの Amazon Simple Storage Service (Amazon S3) URI、またはローカルフォルダへのパスです。

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

タイプ: 文字列

必須: いいえ

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

DataSource

この関数がアタッチされるデータソースの名前です。

• AWS::Serverless::GraphQLApi リソース内のデータソースを参照するには、その論理 ID を指定します。

• AWS::Serverless::GraphQLApi リソース外のデータソースを参照するには、Fn::GetAtt 組み込み関数を使用して、その Name 属性を指定します。例えば !GetAtt MyLambdaDataSource.Name です。

• 別のスタックからのデータソースを参照するには、Fn::ImportValue を使用します。

のバリエーションが指定されている場合、 AWS SAM [NONE | None | none]は AWS::AppSync::DataSource Type オブジェクトNoneの値を生成します。

タイプ: 文字列

必須: はい

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

Description

関数の説明です。

タイプ: 文字列

必須: いいえ

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

Id

AWS::Serverless::GraphQLApi リソース外にある関数の関数 ID です。

• 同じ AWS SAM テンプレート内の関数を参照するには、Fn::GetAtt組み込み関数を使用します。例えば「Id: !GetAtt createPostItemFunc.FunctionId」のようにです。

• 別のスタックからの関数を参照するには、Fn::ImportValue を使用します。

を使用する場合Id、他のすべてのプロパティは許可されません。 AWS SAM は参照される関数の関数 ID を自動的に渡します。

タイプ: 文字列

必須: いいえ

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

InlineCode

リクエスト関数とレスポンス関数が含まれる関数コードです。

タイプ: 文字列

必須: いいえ

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

LogicalId

関数の一意の名前です。

タイプ: 文字列

必須: はい

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

MaxBatchSize

BatchInvoke オペレーションの単一の AWS Lambda 機能に送信されるリゾルバーリクエスト入力の最大数を指定します。

タイプ: 整数

必須: いいえ

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

Name

関数の名前 LogicalId 値を上書きするように指定します。

タイプ: 文字列

必須: いいえ

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

Runtime

AWS AppSync パイプラインリゾルバーまたは AWS AppSync 関数で使用されるランタイムを記述します。使用するランタイムの名前とバージョンを指定します。

タイプ: Runtime

必須: はい

AWS CloudFormation 互換性: このプロパティは に固有 AWS SAM であり、 AWS CloudFormation 同等のプロパティはありません。これは、AWS::AppSync::FunctionConfiguration リソースの Runtime プロパティに似ています。

Sync

関数の Sync 構成について説明します。

関数が呼び出されたときに、どの競合検出戦略および解決戦略を使用するかを指定します。

タイプ： SyncConfig

必須: いいえ

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