SQS

L'objet décrivant un type de source d'événement SQS. Pour plus d'informations, consultez la section Utilisation AWS Lambda avec Amazon SQS dans le manuel du AWS Lambda développeur.

SAM génère une ressource AWS::Lambda::EventSourceMapping lorsque ce type d'événement est défini.

Syntaxe

Pour déclarer cette entité dans votre modèle AWS Serverless Application Model (AWS SAM), utilisez la syntaxe suivante.

YAML

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

Propriétés

BatchSize

Nombre maximum d'éléments à récupérer dans un seul lot.

Type : entier

Obligatoire : non

Par défaut : 10

AWS CloudFormation compatibilité : cette propriété est transmise directement à la BatchSize propriété d'une AWS::Lambda::EventSourceMapping ressource.

Minimum : 1

Maximum : 10000

Enabled

Désactive le mappage de source d'événement pour suspendre l'interrogation et l'appel.

Type : valeur booléenne

Obligatoire : non

AWS CloudFormation compatibilité : cette propriété est transmise directement à la Enabled propriété d'une AWS::Lambda::EventSourceMapping ressource.

FilterCriteria

Objet qui définit les critères permettant de déterminer si Lambda doit traiter un événement. Pour de plus amples informations, veuillez consulter AWS Lambda le filtrage d’événements dans le AWS Lambda Manuel du développeur.

Type : FilterCriteria

Obligatoire : non

AWS CloudFormation compatibilité : cette propriété est transmise directement à la FilterCriteria propriété d'une AWS::Lambda::EventSourceMapping ressource.

FunctionResponseTypes

Une liste des type de réponse actuellement appliquées au mappage de la source d'événement. Pour plus d'informations, veuillez consulter la rubrique Signalement des échecs d'éléments par lot dans le Guide du développeur AWS Lambda .

Valeurs valides : ReportBatchItemFailures

Type : liste

Obligatoire : non

AWS CloudFormation compatibilité : cette propriété est transmise directement à la FunctionResponseTypes propriété d'une AWS::Lambda::EventSourceMapping ressource.

MaximumBatchingWindowInSeconds

L'intervalle de temps maximal (en secondes) pour collecter des enregistrements avant d'appeler la fonction.

Type : entier

Obligatoire : non

AWS CloudFormation compatibilité : cette propriété est transmise directement à la MaximumBatchingWindowInSeconds propriété d'une AWS::Lambda::EventSourceMapping ressource.

Queue

L'ARN de la file d'attente.

Type : chaîne

Obligatoire : oui

AWS CloudFormation compatibilité : cette propriété est transmise directement à la EventSourceArn propriété d'une AWS::Lambda::EventSourceMapping ressource.

ScalingConfig

Mise à l'échelle de la configuration des observateurs SQS pour contrôler le taux d'appels et définir le nombre maximal d'appels simultanés.

Type : ScalingConfig

Obligatoire : non

AWS CloudFormation compatibilité : cette propriété est transmise directement à la ScalingConfig propriété d'une AWS::Lambda::EventSourceMapping ressource.

Exemples

Événement SQS de base

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"]}'

Configurer des rapports partiels par lots pour votre file d'attente SQS

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

Fonction Lambda avec un événement SQS pour lequel la mise à l'échelle est configurée

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