SQS

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

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

構文

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

YAML

  BatchSize: Integer
  Enabled: Boolean
  FilterCriteria: FilterCriteria
  FunctionResponseTypes: List
  KmsKeyArn: String	
  MaximumBatchingWindowInSeconds: Integer
  MetricsConfig: MetricsConfig
  Queue: String
  ScalingConfig: ScalingConfig

プロパティ

BatchSize

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

タイプ: 整数

必須: いいえ

デフォルト: 10

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

最小: 1

最大: 10000

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

KmsKeyArn

このイベントに関連する情報を暗号化するためのキーの Amazon リソースネーム (ARN)。

型: 文字列

必須: いいえ

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

MaximumBatchingWindowInSeconds

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

タイプ: 整数

必須: いいえ

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

MetricsConfig

処理の各ステージをキャプチャするイベントソースマッピングの拡張メトリクスを取得するためのオプトイン設定。例については、MetricsConfig イベントを参照してください。

タイプ: MetricsConfig

必須: いいえ

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

Queue

キューの ARN です。

型: 文字列

必須: はい

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

ScalingConfig

SQS ポーラーのスケーリング設定により、呼び出し速度を制御し、同時呼び出しの最大数を設定します。

タイプ: ScalingConfig

必須: いいえ

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

例

MetricsConfig イベント

以下は、 MetricsConfigプロパティを使用してイベントソースマッピングの各処理ステージをキャプチャするリソースの例です。

Resources:
  FilteredEventsFunction:
    Type: AWS::Serverless::Function
    Properties:
      CodeUri: s3://sam-demo-bucket/metricsConfig.zip
      Handler: index.handler
      Runtime: nodejs16.x
      Events:
        KinesisStream:
          Type: Kinesis
          Properties:
            Stream: !GetAtt KinesisStream.Arn
            StartingPosition: LATEST
            MetricsConfig:
              Metrics:
              - EventCount

基本的な SQS イベント

Events:
  SQSEvent:
    Type: SQS
    Properties:
      Queue: arn:aws:sqs:us-west-2:012345678901:my-queue
      BatchSize: 10
      Enabled: false
      FilterCriteria: 
        Filters: 
          - Pattern: '{"key": ["val1", "val2"]}'

SQS キューの部分的なバッチレポートを設定する

Events:
  SQSEvent:
    Type: SQS
    Properties:
      Enabled: true
      FunctionResponseTypes:
        - ReportBatchItemFailures
      Queue: !GetAtt MySqsQueue.Arn
      BatchSize: 10

スケーリングが設定された SQS イベントを含む Lambda 関数

MyFunction:
  Type: AWS::Serverless::Function
  Properties:
    ...
    Events:
      MySQSEvent:
        Type: SQS
        Properties:
          ...
          ScalingConfig:
            MaximumConcurrency: 10