SQS - AWS Serverless Application Model
SintaxePropriedadesExemplos

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

SQS

O objeto que descreve um tipo de origem do evento SQS. Para obter mais informações, consulte Como usar AWS Lambda com o Amazon SQS no Guia do AWS Lambda desenvolvedor.

O SAM gera recursos AWS::Lambda::EventSourceMapping quando esse tipo de evento é definido

Sintaxe

Para declarar essa entidade em seu modelo AWS Serverless Application Model (AWS SAM), use a sintaxe a seguir.

Propriedades

BatchSize

O número máximo de itens a serem recuperados em um único lote.

Tipo: inteiro

Obrigatório: não

Padrão: 10

CloudFormation compatibilidade: essa propriedade é passada diretamente para a BatchSize propriedade de um AWS::Lambda::EventSourceMapping recurso.

Mínimo: 1

Maximum: 10000

Enabled

Desabilita o mapeamento de origens de eventos para pausar a sondagem e a invocação.

Tipo: booliano

Obrigatório: não

CloudFormation compatibilidade: essa propriedade é passada diretamente para a Enabled propriedade de um AWS::Lambda::EventSourceMapping recurso.

FilterCriteria

Um objeto que define os critérios para determinar se o Lambda deve processar um evento. Para obter mais informações, consulte Filtrando eventos do AWS Lambda no Guia do desenvolvedor do AWS Lambda .

Digite: FilterCriteria

Obrigatório: não

CloudFormation compatibilidade: essa propriedade é passada diretamente para a FilterCriteria propriedade de um AWS::Lambda::EventSourceMapping recurso.

FunctionResponseTypes

Uma lista de tipos de resposta atuais aplicados ao mapeamento da origem do evento. Para obter mais informações, consulte Relatar falhas de itens em lote no Guia do desenvolvedor do AWS Lambda .

Valores válidos: ReportBatchItemFailures

Tipo: lista

Obrigatório: não

CloudFormation compatibilidade: essa propriedade é passada diretamente para a FunctionResponseTypes propriedade de um AWS::Lambda::EventSourceMapping recurso.

KmsKeyArn

O nome do recurso da Amazon (ARN) da chave para criptografar informações relacionadas a esse evento.

Tipo: string

Obrigatório: não

CloudFormation compatibilidade: essa propriedade é passada diretamente para a KmsKeyArn propriedade de um AWS::Lambda::EventSourceMapping recurso.

MaximumBatchingWindowInSeconds

O tempo máximo, em segundos, para coletar registros antes de invocar a função.

Tipo: inteiro

Obrigatório: não

CloudFormation compatibilidade: essa propriedade é passada diretamente para a MaximumBatchingWindowInSeconds propriedade de um AWS::Lambda::EventSourceMapping recurso.

MetricsConfig

Uma configuração opcional para obter métricas aprimoradas para os mapeamentos da origem do evento que capturam cada estágio do processamento. Para ver um exemplo, consulte Evento do MetricsConfig.

Digite: MetricsConfig

Obrigatório: não

CloudFormation compatibilidade: essa propriedade é passada diretamente para a MetricsConfig propriedade de um AWS::Lambda::EventSourceMapping recurso.

ProvisionedPollerConfig

Configuração para aumentar a quantidade de sondagens usados para computar os mapeamentos da origem do evento. Essa configuração permite um mínimo de 2 pollers e um máximo de 2.000 pollers. Para obter um exemplo, consulte ProvisionedPollerConfig exemplo.

Digite: ProvisionedPollerConfig

Obrigatório: não

CloudFormation compatibilidade: essa propriedade é passada diretamente para a ProvisionedPollerConfig propriedade de um AWS::Lambda::EventSourceMapping recurso.

Queue

O ARN da fila.

Tipo: string

Obrigatório: Sim

CloudFormation compatibilidade: essa propriedade é passada diretamente para a EventSourceArn propriedade de um AWS::Lambda::EventSourceMapping recurso.

ScalingConfig

Configuração de escalabilidade dos agentes de sondagem SQS para controlar a taxa de invocação e definir o máximo de invocações simultâneas.

Digite: ScalingConfig

Obrigatório: não

CloudFormation compatibilidade: essa propriedade é passada diretamente para a ScalingConfig propriedade de um AWS::Lambda::EventSourceMapping recurso.

Exemplos

MetricsConfig evento

Veja a seguir um exemplo de um recurso que usa a propriedade MetricsConfig para capturar cada estágio de processamento para seus mapeamentos da origem do evento.

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

Configure relatórios parciais em lotes para sua fila SQS

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

Função do Lambda com um evento SQS que tem escalabilidade configurada

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

ProvisionedPollerConfig exemplo

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