SQS - AWS Serverless Application Model
SintaxisPropiedadesEjemplos

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

SQS

El objeto que describe un tipo de fuente de evento de SQS. Para obtener más información, consulte Uso AWS Lambda con Amazon SQS en la Guía para AWS Lambda desarrolladores.

SAM genera recursos de AWS::Lambda::EventSourceMapping cuando se establece este tipo de evento

Sintaxis

Para declarar esta entidad en su plantilla AWS Serverless Application Model (AWS SAM), utilice la siguiente sintaxis.

Propiedades

BatchSize

El número máximo de elementos que se recuperan en un único lote.

Tipo: entero

Obligatorio: no

Valor predeterminado: 10

CloudFormation compatibilidad: esta propiedad se pasa directamente a la BatchSize propiedad de un AWS::Lambda::EventSourceMapping recurso.

Mínimo: 1

Máximo: 10000

Enabled

Deshabilita el mapeo de origen de eventos para pausar el sondeo y la invocación.

Tipo: Booleano

Obligatorio: no

CloudFormation compatibilidad: esta propiedad se pasa directamente a la Enabled propiedad de un AWS::Lambda::EventSourceMapping recurso.

FilterCriteria

Un objeto que define los criterios que determinan si Lambda debe procesar un evento o no. Para obtener más información, consulta Filtrado de eventos de AWS Lambda en la Guía para desarrolladores de AWS Lambda .

Tipo: FilterCriteria

Obligatorio: no

CloudFormation compatibilidad: esta propiedad se pasa directamente a la FilterCriteria propiedad de un AWS::Lambda::EventSourceMapping recurso.

FunctionResponseTypes

Una lista de enumeraciones de tipos de respuesta actuales aplicadas a la asignación de origen de eventos. Para obtener más información, consulta Informes de errores de artículos en lotes en la Guía para desarrolladores de AWS Lambda .

Valores válidos: ReportBatchItemFailures

Tipo: lista

Obligatorio: no

CloudFormation compatibilidad: esta propiedad se pasa directamente a la FunctionResponseTypes propiedad de un AWS::Lambda::EventSourceMapping recurso.

KmsKeyArn

El nombre de recurso de Amazon (ARN) de la clave de que se utilizará para cifrar la información de este evento.

Tipo: cadena

Obligatorio: no

CloudFormation compatibilidad: esta propiedad se pasa directamente a la KmsKeyArn propiedad de un AWS::Lambda::EventSourceMapping recurso.

MaximumBatchingWindowInSeconds

La cantidad de tiempo máxima, en segundos, para recopilar registros antes de invocar la función.

Tipo: entero

Obligatorio: no

CloudFormation compatibilidad: esta propiedad se pasa directamente a la MaximumBatchingWindowInSeconds propiedad de un AWS::Lambda::EventSourceMapping recurso.

MetricsConfig

Una configuración opcional para obtener métricas mejoradas para las asignaciones de orígenes de eventos que capturan cada etapa del procesamiento. Para ver un ejemplo, consulta Evento de MetricsConfig.

Tipo: MetricsConfig

Obligatorio: no

CloudFormation compatibilidad: esta propiedad se pasa directamente a la MetricsConfig propiedad de un AWS::Lambda::EventSourceMapping recurso.

ProvisionedPollerConfig

Configuración para aumentar la cantidad de sondeos utilizados para calcular las asignaciones de orígenes de eventos. Esta configuración permite un mínimo de 2 sondeadores y un máximo de 2000 sondeos. Para ver un ejemplo, consulte ProvisionedPollerConfig ejemplo.

Tipo: ProvisionedPollerConfig

Obligatorio: no

CloudFormation compatibilidad: esta propiedad se transfiere directamente a la ProvisionedPollerConfig propiedad de un AWS::Lambda::EventSourceMapping recurso.

Queue

El ARN de la cola.

Tipo: cadena

Obligatorio: sí

CloudFormation compatibilidad: esta propiedad se pasa directamente a la EventSourceArn propiedad de un AWS::Lambda::EventSourceMapping recurso.

ScalingConfig

Configuración del escalado de los pollers SQS para controlar la tasa de invocaciones y establecer el máximo de invocaciones simultáneas.

Tipo: ScalingConfig

Obligatorio: no

CloudFormation compatibilidad: esta propiedad se pasa directamente a la ScalingConfig propiedad de un AWS::Lambda::EventSourceMapping recurso.

Ejemplos

MetricsConfig evento

El siguiente ejemplo muestra un recurso que usa la propiedad MetricsConfig para capturar cada etapa del procesamiento para sus asignaciones de orígenes de eventos.

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

Evento de SQS básico

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

Configura los informes por lotes parciales para su cola de SQS

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

Función de Lambda con un evento SQS que tiene el escalado configurado

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

ProvisionedPollerConfig ejemplo

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