函式 - 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 或本地文件夾的路徑。

如果您指定本機資料夾的路徑，則 AWS CloudFormation 需要在部署之前先將檔案上傳到 Amazon S3。您可以使用 AWS SAMCLI來促進此程序。如需詳細資訊，請參閱 如何在部署時 AWS SAM 上傳本機檔案。

類型：字串

必要：否

AWS 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::DataSourceType物件的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 函數使用的執行階段。指定要使用的執行階段名稱和版本。

類型：運行時

必要：是

AWS CloudFormation 兼容性：此屬性是唯一的， AWS SAM 並且沒有相 AWS CloudFormation 等的屬性。它類似於資AWS::AppSync::FunctionConfiguration源的Runtime屬性。

Sync

描述函數的同步配置。

指定呼叫函數時要使用的衝突偵測策略與解決策略。

類型:SyncConfig

必要：否

AWS CloudFormation 兼容性：此屬性直接傳遞給AWS::AppSync::FunctionConfiguration資源的SyncConfig屬性。