

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

# SQS
<a name="sam-property-function-sqs"></a>

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](https://docs.aws.amazon.com/lambda/latest/dg/with-sqs.html) dans le manuel du *AWS Lambda développeur*.

SAM génère une ressource [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html) lorsque ce type d'événement est défini.

## Syntaxe
<a name="sam-property-function-sqs-syntax"></a>

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

### YAML
<a name="sam-property-function-sqs-syntax.yaml"></a>

```
  [BatchSize](#sam-function-sqs-batchsize): Integer
  [Enabled](#sam-function-sqs-enabled): Boolean
  [FilterCriteria](#sam-function-sqs-filtercriteria): [FilterCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html)
  [FunctionResponseTypes](#sam-function-sqs-functionresponsetypes): List
  KmsKeyArn: String
  [MaximumBatchingWindowInSeconds](#sam-function-sqs-maximumbatchingwindowinseconds): Integer
  [MetricsConfig](#sam-function-sqs-metricsconfig): [MetricsConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-metricsconfig)
  [ProvisionedPollerConfig](#sam-function-sqs-provisionedpollerconfig): [ProvisionedPollerConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-provisionedpollerconfig)
  [Queue](#sam-function-sqs-queue): String
  ScalingConfig: [ScalingConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-scalingconfig.html)
```

## Propriétés
<a name="sam-property-function-sqs-properties"></a>

 `BatchSize`   <a name="sam-function-sqs-batchsize"></a>
Nombre maximum d'éléments à récupérer dans un seul lot.  
*Type* : entier  
*Obligatoire* : non  
*Par défaut* : 10  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[BatchSize](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-batchsize)` propriété d'une `AWS::Lambda::EventSourceMapping` ressource.  
*Minimum *: `1`  
*Maximum *: `10000`

 `Enabled`   <a name="sam-function-sqs-enabled"></a>
Désactive le mappage de source d'événement pour suspendre l'interrogation et l'appel.  
*Type* : valeur booléenne  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[Enabled](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-enabled)` propriété d'une `AWS::Lambda::EventSourceMapping` ressource.

 `FilterCriteria`   <a name="sam-function-sqs-filtercriteria"></a>
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](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html) dans le *AWS Lambda Manuel du développeur*.  
*Type :* [FilterCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html)  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[FilterCriteria](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-filtercriteria.html)` propriété d'une `AWS::Lambda::EventSourceMapping` ressource.

 `FunctionResponseTypes`   <a name="sam-function-sqs-functionresponsetypes"></a>
 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](https://docs.aws.amazon.com/lambda/latest/dg/with-sqs.html#services-sqs-batchfailurereporting) dans le *Guide du développeur AWS Lambda *.   
 *Valeurs valides* : `ReportBatchItemFailures`   
 *Type* : liste   
 *Obligatoire* : non   
 *CloudFormation compatibilité* : cette propriété est transmise directement à la `[FunctionResponseTypes](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-functionresponsetypes)` propriété d'une `AWS::Lambda::EventSourceMapping` ressource. 

 `KmsKeyArn`   <a name="sam-function-sqs-kmskeyarn"></a>
Le nom de ressource Amazon (ARN) de la clé permettant de chiffrer les informations relatives à cet événement.  
*Type* : chaîne  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[KmsKeyArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-kmskeyarn)` propriété d'une `AWS::Lambda::EventSourceMapping` ressource.

 `MaximumBatchingWindowInSeconds`   <a name="sam-function-sqs-maximumbatchingwindowinseconds"></a>
L'intervalle de temps maximal (en secondes) pour collecter des enregistrements avant d'appeler la fonction.  
*Type* : entier  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[MaximumBatchingWindowInSeconds](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-maximumbatchingwindowinseconds)` propriété d'une `AWS::Lambda::EventSourceMapping` ressource.

 `MetricsConfig`   <a name="sam-function-sqs-metricsconfig"></a>
Une configuration optionnelle permettant d'obtenir des métriques améliorées pour les mappages de sources d'événements qui capturent chaque étape du traitement. Pour obtenir un exemple, consultez [MetricsConfig événement](sam-property-function-dynamodb.md#sam-property-function-dynamodb-example-metricsconfigevent).  
*Type :* [MetricsConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-metricsconfig)  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[MetricsConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-metricsconfig)` propriété d'une `AWS::Lambda::EventSourceMapping` ressource.

 `ProvisionedPollerConfig`   <a name="sam-function-sqs-provisionedpollerconfig"></a>
Configuration pour augmenter le nombre de sondeurs utilisés pour calculer les mappages de sources d'événements. Cette configuration permet un minimum de 2 sondeurs et un maximum de 2 000 sondeurs. Pour un exemple, reportez-vous à[ProvisionedPollerConfig exemple](#sam-property-function-sqs-example-provisionedpollerconfig).  
*Type :* [ProvisionedPollerConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-provisionedpollerconfig)  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[ProvisionedPollerConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-provisionedpollerconfig)` propriété d'une `AWS::Lambda::EventSourceMapping` ressource.

 `Queue`   <a name="sam-function-sqs-queue"></a>
L'ARN de la file d'attente.  
*Type* : chaîne  
*Obligatoire* : oui  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[EventSourceArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-eventsourcemapping.html#cfn-lambda-eventsourcemapping-eventsourcearn)` propriété d'une `AWS::Lambda::EventSourceMapping` ressource.

 `ScalingConfig`   <a name="sam-function-sqs-scalingconfig"></a>
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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-scalingconfig.html)`  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est transmise directement à la `[ ScalingConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-eventsourcemapping-scalingconfig.html)` propriété d'une `AWS::Lambda::EventSourceMapping` ressource.

## Exemples
<a name="sam-property-function-sqs--examples"></a>

### MetricsConfig événement
<a name="sam-property-function-sqs-example-metricsconfigevent"></a>

Voici un exemple de ressource qui utilise la `MetricsConfig` propriété pour capturer chaque étape du traitement pour ses mappages de sources d'événements.

```
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
```

### Événement SQS de base
<a name="sam-property-function-sqs--examples--sqs-event"></a>

```
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
<a name="sam-property-function-sqs--examples--sqs-partial-batch"></a>

```
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
<a name="sam-property-function-sqs--examples--sqs-event-scaling"></a>

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

### ProvisionedPollerConfig exemple
<a name="sam-property-function-sqs-example-provisionedpollerconfig"></a>

```
MyFunction:
  Type: AWS::Serverless::Function
  Properties:
    Handler: index.handler
    Runtime: nodejs18.x
    Timeout: 30
    Events:
      SQSEvent:
        Type: SQS
        Properties:
          Queue: !GetAtt MyQueue.Arn
          BatchSize: 10
          Enabled: True
          ProvisionedPollerConfig:
            MaximumPollers: 300
            MinimumPollers: 10
```