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

Kinesis

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

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

構文

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

プロパティ

BatchSize

単一のバッチで取得する項目の最大数です。

タイプ: 整数

必須: いいえ

デフォルト: 100

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

最小: 1

最大: 10000

BisectBatchOnFunctionError

関数がエラーを返す場合は、バッチを 2 つに分割して再試行します。

タイプ: ブール

必須: いいえ

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

DestinationConfig

破棄されたレコードのための Amazon Simple Queue Service (Amazon SQS) キューまたは Amazon Simple Notification Service (Amazon SNS) トピック送信先です。

タイプ: DestinationConfig

必須: いいえ

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

Enabled

ポーリングと呼び出しを一時停止するために、イベントソースマッピングを無効にします。

タイプ: ブール

必須: いいえ

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

FilterCriteria

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

タイプ: FilterCriteria

必須: いいえ

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

FunctionResponseTypes

現在イベントソースマッピングに適用されているレスポンスタイプのリストです。詳細については、AWS Lambda デベロッパーガイドの「バッチアイテムの失敗をレポートする」を参照してください。

有効な値: ReportBatchItemFailures

タイプ: リスト

必須: いいえ

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

MaximumBatchingWindowInSeconds

関数を呼び出すまでのレコード収集の最大時間 (秒) です。

タイプ: 整数

必須: いいえ

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

MaximumRecordAgeInSeconds

Lambda が処理のために関数に送信するレコードの最大存続時間です。

タイプ: 整数

必須: いいえ

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

MaximumRetryAttempts

関数がエラーを返すときの最大再試行回数です。

タイプ: 整数

必須: いいえ

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

ParallelizationFactor

各シャードから同時に処理するバッチの数です。

タイプ: 整数

必須: いいえ

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

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 プロパティに直接渡されます。

TumblingWindowInSeconds

処理ウィンドウの継続時間 (秒) です。有効範囲は 1～900 (15 分) です。

詳細については、AWS Lambda デベロッパーガイドの「タンブリングウィンドウ」を参照してください。

タイプ: 整数

必須: いいえ

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

例

Kinesis イベントソース

以下は、Kinesis イベントソースの例です。

YAML

Events:
  KinesisEvent:
    Type: Kinesis
    Properties:
      Stream: arn:aws:kinesis:us-east-1:123456789012:stream/my-stream
      StartingPosition: TRIM_HORIZON
      BatchSize: 10
      Enabled: false
      FilterCriteria: 
        Filters: 
          - Pattern: '{"key": ["val1", "val2"]}'