Kinesis

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

AWS SAM gera um AWS::Lambda::EventSourceMappingrecurso 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.

YAML

  BatchSize: Integer
  BisectBatchOnFunctionError: Boolean
  DestinationConfig: DestinationConfig
  Enabled: Boolean
  FilterCriteria: FilterCriteria
  FunctionResponseTypes: List
  KmsKeyArn: String          
  MaximumBatchingWindowInSeconds: Integer
  MaximumRecordAgeInSeconds: Integer
  MaximumRetryAttempts: Integer
  MetricsConfig: MetricsConfig
  ParallelizationFactor: Integer
  StartingPosition: String
  StartingPositionTimestamp: Double
  Stream: String
  TumblingWindowInSeconds: Integer

Propriedades

BatchSize

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

Tipo: inteiro

Obrigatório: não

Padrão: 100

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

Mínimo: 1

Maximum: 10000

BisectBatchOnFunctionError

Se a função retornar um erro, divida o lote em dois e tente novamente.

Tipo: booliano

Obrigatório: não

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

DestinationConfig

Uma fila do Amazon Simple Queue Service (AmazonSQS) ou um destino de tópico do Amazon Simple Notification Service SNS (Amazon) para registros descartados.

Digite: DestinationConfig

Obrigatório: não

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

Enabled

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

Tipo: booliano

Obrigatório: não

AWS 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

AWS 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

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

KmsKeyArn

O Amazon Resource Name (ARN) da chave para criptografar informações relacionadas a esse evento.

Type: string

Obrigatório: não

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

MaximumBatchingWindowInSeconds

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

Tipo: inteiro

Obrigatório: não

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

MaximumRecordAgeInSeconds

A idade máxima de um registro que o Lambda envia a uma função para processamento.

Tipo: inteiro

Obrigatório: não

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

MaximumRetryAttempts

O número máximo de vezes para tentar novamente quando a função retorna um erro.

Tipo: inteiro

Obrigatório: não

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

MetricsConfig

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

Digite: MetricsConfig

Obrigatório: não

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

ParallelizationFactor

O número de lotes a serem processados de cada fragmento simultaneamente.

Tipo: inteiro

Obrigatório: não

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

StartingPosition

A posição em um fluxo da qual você deseja iniciar a leitura.

• AT_TIMESTAMP – Especifique um tempo a partir do qual iniciar a leitura dos registros.

• LATEST – Leia somente registros novos.

• TRIM_HORIZON – Processe todos os registros disponíveis.

Valores válidos: AT_TIMESTAMP | LATEST | TRIM_HORIZON

Type: string

Obrigatório: Sim

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

StartingPositionTimestamp

O tempo a partir do qual iniciar a leitura, em segundos no horário do Unix. Defina StartingPositionTimestamp quando StartingPosition é especificado como .AT_TIMESTAMP

Tipo: duplo

Obrigatório: não

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

Stream

O Amazon Resource Name (ARN) do stream de dados ou do consumidor do stream.

Type: string

Obrigatório: Sim

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

TumblingWindowInSeconds

A duração, em segundos, de uma janela de processamento. O intervalo válido é de 1 a 900 (15 minutos).

Para obter mais informações, consulte Janelas caindo no Guia do desenvolvedor do AWS Lambda .

Tipo: inteiro

Obrigatório: não

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

Exemplos

MetricsConfig evento

Veja a seguir um exemplo de um recurso que usa a MetricsConfig propriedade para capturar cada estágio de processamento para seus mapeamentos de origem 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

Fonte do evento do Kinesis

Veja a seguir um exemplo de uma fonte de eventos do Kinesis.

YAML

Events:
  KinesisEvent:
    Type: Kinesis
    Properties:
      Stream: arn:aws:kinesis:us-east-1:123456789012:stream/my-stream
      StartingPosition: TRIM_HORIZON
      BatchSize: 10
      Enabled: false
      FilterCriteria: 
        Filters: 
          - Pattern: '{"key": ["val1", "val2"]}'