函数

在 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 SAMCLI。

类型：字符串

必需：否

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属性。