MSK

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

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

语法

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

YAML

  ConsumerGroupId: String
  DestinationConfig: DestinationConfig
  FilterCriteria: FilterCriteria
  KmsKeyArn: String 
  MaximumBatchingWindowInSeconds: Integer
  SourceAccessConfigurations: SourceAccessConfigurations
  StartingPosition: String
  StartingPositionTimestamp: Double
  Stream: String
  Topics: List

属性

ConsumerGroupId

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

类型：字符串

必需：否

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

DestinationConfig

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

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

类型:DestinationConfig

必需：否

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

FilterCriteria

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

类型:FilterCriteria

必需：否

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

KmsKeyArn

用于加密与此事件相关的信息的密钥的 Amazon 资源名称 (ARN)。

类型：字符串

必需：否

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

MaximumBatchingWindowInSeconds

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

类型：整数

必需：否

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

SourceAccessConfigurations

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

有效值：CLIENT_CERTIFICATE_TLS_AUTH

类型：清单 SourceAccessConfiguration

必需：否

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

StartingPosition

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

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

• LATEST - 仅读取新记录。

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

有效值：AT_TIMESTAMP | LATEST | TRIM_HORIZON

类型：字符串

必需：否

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

StartingPositionTimestamp

开始读取的时间（以 Unix 时间秒为单位） 在 StartingPosition 被指定为 AT_TIMESTAMP 的情况下定义 StartingPositionTimestamp。

类型：双精度

必需：否

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

Stream

数据流或流使用者的 Amazon 资源名称 (ARN)。

类型：字符串

必需：是

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

Topics

Kafka 主题的名称。

类型：列表

必需：是

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

示例

Amazon 现有集群MSK示例

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

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