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 事件

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