MSK - AWS Serverless Application Model
構文プロパティ例

MSK

MSK イベントソースタイプを説明するオブジェクトです。詳細については、AWS Lambda デベロッパーガイドの「Amazon MSK での AWS Lambda の使用」を参照してください。

このイベントタイプが設定されていると、AWS Serverless Application Model (AWS SAM) は AWS::Lambda::EventSourceMapping リソースを生成します。

構文

AWS SAM テンプレートでこのエンティティを宣言するには、以下の構文を使用します。

プロパティ

ConsumerGroupId

Kafka トピックからイベントを読み取る方法を設定する文字列。

タイプ: 文字列

必須: いいえ

AWS CloudFormation との互換性: このプロパティは、AWS::Lambda::EventSourceMapping リソースの AmazonManagedKafkaConfiguration プロパティに直接渡されます。

FilterCriteria

Lambda がイベントを処理する必要があるかどうかを判断する基準を定義するオブジェクト。詳細については、AWS Lambda デベロッパーガイドの AWS Lambda イベントのフィルタリングを参照してください。

タイプ: FilterCriteria

必須: いいえ

AWS CloudFormation との互換性: このプロパティは、AWS::Lambda::EventSourceMapping リソースの FilterCriteria プロパティに直接渡されます。

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

以下は、AWS アカウント に既に存在する 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