関数 - AWS Serverless Application Model
構文プロパティ

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

関数

特定のオペレーションを実行するように 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、またはローカルフォルダへのパスです。

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

タイプ: 文字列

必須: いいえ

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

DataSource

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

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

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

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

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

タイプ: 文字列

必須: はい

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

Description

関数の説明です。

タイプ: 文字列

必須: いいえ

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

Id

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

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

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

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

タイプ: 文字列

必須: いいえ

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

InlineCode

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

タイプ: 文字列

必須: いいえ

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

LogicalId

関数の一意の名前です。

タイプ: 文字列

必須: はい

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

MaxBatchSize

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

タイプ: 整数

必須: いいえ

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

Name

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

タイプ: 文字列

必須: いいえ

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

Runtime

AWS AppSync パイプラインリゾルバーまたは AWS AppSync 関数が使用するランタイムについて説明します。使用するランタイムの名前とバージョンを指定します。

タイプ: Runtime

必須: はい

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

Sync

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

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

タイプ: SyncConfig

必須: いいえ

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