SQS
SQS
イベントソースタイプを説明するオブジェクトです。詳細については、AWS Lambda デベロッパーガイドの「AWS Lambda を Amazon SQS に使用する」を参照してください。
このイベントタイプが設定されていると、SAM は AWS::Lambda::EventSourceMapping リソースを生成します。
構文
AWS Serverless Application Model (AWS SAM) テンプレートでこのエンティティを宣言するには、以下の構文を使用します。
YAML
BatchSize:
Integer
Enabled:Boolean
FilterCriteria:FilterCriteria
FunctionResponseTypes:List
MaximumBatchingWindowInSeconds:Integer
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
プロパティに直接渡されます。 -
MaximumBatchingWindowInSeconds
-
関数を呼び出すまでのレコード収集の最大時間 (秒) です。
タイプ: 整数
必須: いいえ
AWS CloudFormation との互換性: このプロパティは、
AWS::Lambda::EventSourceMapping
リソースのMaximumBatchingWindowInSeconds
プロパティに直接渡されます。 -
Queue
-
キューの ARN です。
タイプ: 文字列
必須: はい
AWS CloudFormation との互換性: このプロパティは、
AWS::Lambda::EventSourceMapping
リソースのEventSourceArn
プロパティに直接渡されます。 -
ScalingConfig
-
SQS ポーラーのスケーリング設定により、呼び出し速度を制御し、同時呼び出しの最大数を設定します。
[Type] (タイプ):
ScalingConfig
必須: いいえ
AWS CloudFormation との互換性: このプロパティは、
AWS::Lambda::EventSourceMapping
リソースのScalingConfig
プロパティに直接渡されます。
例
SQS イベント
SQS イベント
YAML
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 イベントを含む Lambda 関数
MyFunction: Type: AWS::Serverless::Function Properties: ... Events: MySQSEvent: Type: SQS Properties: ... ScalingConfig: MaximumConcurrency: 10