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

DestinationConfig

一个配置对象,用于在 Lambda 处理事件后指定事件目的地。

使用此属性指定来自 Amazon MSK 事件源的失败调用的目的地。

类型:DestinationConfig

必需:否

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

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 时间秒为单位) 在 StartingPosition 被指定为 AT_TIMESTAMP 的情况下定义 StartingPositionTimestamp

类型:双精度

必需:否

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 Web Services 账户 中已存在的 Amazon MSK 集群的 MSK 事件源类型。

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