MSK - Amazon Serverless Application Model
语法属性示例
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异，请参阅中国的 Amazon Web Services 服务入门。

本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

MSK

描述一个MSK事件源类型。有关更多信息，请参阅 。使用Amazon Lambda使用Amazon MSK中的Amazon Lambda开发人员指南.

Amazon SAM生成AWS::Lambda::EventSourceMapping设置此事件类型时的资源。

语法

要在您的Amazon Serverless Application Model(Amazon SAM) 模板，请使用以下语法。

YAML

  ConsumerGroupId: String
  MaximumBatchingWindowInSeconds: Integer
  StartingPosition: String
  Stream: String
  Topics: List

属性

ConsumerGroupId

一个字符串，用于配置如何从 Kafka 主题中读取事件。

类型：字符串

必需：否

Amazon CloudFormation兼容性：此属性将直接传递给AmazonManagedKafkaConfiguration一个的财产AWS::Lambda::EventSourceMapping资源。

MaximumBatchingWindowInSeconds

在调用函数之前收集记录的最长时间（以秒为单位）。

类型：整数

必需：否

Amazon CloudFormation兼容性：此属性将直接传递给MaximumBatchingWindowInSeconds一个的财产AWS::Lambda::EventSourceMapping资源。

StartingPosition

在流中开始读取数据的位置。

有效值：TRIM_HORIZON 或 LATEST

类型：字符串

必需：是

Amazon CloudFormation兼容性：此属性将直接传递给StartingPosition一个的财产AWS::Lambda::EventSourceMapping资源。

Stream

数据流或流使用者的Amazon Resource Name (ARN)。

类型：字符串

必需：是

Amazon CloudFormation兼容性：此属性将直接传递给EventSourceArn一个的财产AWS::Lambda::EventSourceMapping资源。

Topics

Kafka 主题的名称。

类型：List

必需：是

Amazon CloudFormation兼容性：此属性将直接传递给Topics一个的财产AWS::Lambda::EventSourceMapping资源。

示例

现有集群的 Amazon MSK 示例

以下是的示例MSKAmazon MSK 集群的事件源类型，该集群已存在于Amazonaccount.

YAML

Events:
  MSKEvent:
    Type: MSK
    Properties:
      StartingPosition: LATEST
      Stream: arn:aws:kafka:us-east-1:012345678012:cluster/exampleClusterName/abcdefab-1234-abcd-5678-cdef0123ab01-2
      Topics:
        - MyTopic

在同一模板中声明的集群的 Amazon MSK 示例

以下是的示例MSK在同一模板文件中声明的 Amazon MSK 集群的事件源类型。

YAML

Events:
  MSKEvent:
    Type: MSK
    Properties:
      StartingPosition: LATEST
      Stream:
        Ref: MyMskCluster   # This must be the name of an MSK cluster declared in the same template file
      Topics:
        - MyTopic