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

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

MSK

描述MSK事件源类型的对象。有关更多信息，请参阅《Amazon Lambda开发者指南》Amazon Lambda中的 “在 Amazon MSK 上使用”。

Amazon Serverless Application Model(Amazon SAM) 在设置此事件类型时生成AWS::Lambda::EventSourceMapping资源。

语法

要在Amazon SAM模板中声明此实体，请使用以下语法。

属性

ConsumerGroupId

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

类型：字符串

必需：否

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

FilterCriteria

定义用于确定 Lambda 是否应处理事件的标准的对象。有关更多信息，请参阅《Amazon Lambda开发者指南》中的Amazon Lambda事件筛选。

类型：FilterCriteria

必需：否

Amazon CloudFormation兼容性：此属性直接传递给AWS::Lambda::EventSourceMapping资源的FilterCriteria属性。

MaximumBatchingWindowInSeconds

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

类型：整数

必需：否

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

SourceAccessConfigurations

用于保护与定义事件源的身份验证协议数组 VPC 组件或虚拟化主机。

有效值：CLIENT_CERTIFICATE_TLS_AUTH

类型：SourceAccessConfiguration 列表

必需：否

Amazon CloudFormation兼容性：此属性直接传递给AWS::Lambda::EventSourceMapping资源的SourceAccessConfigurations属性。

StartingPosition

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

  • AT_TIMESTAMP— 指定开始读取记录的时间。

  • LATEST— 仅读取新记录。

  • TRIM_HORIZON— 处理所有可用的记录。

有效值：AT_TIMESTAMP | LATEST | TRIM_HORIZON

类型：字符串

必需：是

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

StartingPositionTimestamp

开始读取的时间（以 Unix 时间秒为单位）。定义StartingPositionTimestamp何时指定StartingPosition为AT_TIMESTAMP。

类型：双精度

必需：否

Amazon CloudFormation兼容性：此属性直接传递给AWS::Lambda::EventSourceMapping资源的StartingPositionTimestamp属性。

Stream

数据流的 Amazon 资源名称 (ARN)。

类型：字符串

必需：是

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

Topics

Kafka 主题的名称。

类型：清单

必需：是

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

示例

现有集群的 Amazon MSK 示例

以下是已存在于 Amazon MSK 集群MSK的事件源类型的示例Amazon Web Services 账户。

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 示例

以下是在同一模板文件中声明的 Amazon MSK 集群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