Kinesis - 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.

Kinesis

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

AWS SAM genera un recurso AWS::Lambda::EventSourceMapping cuando se establece este tipo de evento.

Sintaxis

Para declarar esta entidad en su plantilla de AWS Serverless Application Model (AWS SAM), usa la siguiente sintaxis:

Propiedades

BatchSize

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

Tipo: entero

Obligatorio: no

predeterminado: 100

Compatibilidad con CloudFormation: esta propiedad se transfiere directamente a la propiedad BatchSize de un recurso AWS::Lambda::EventSourceMapping.

Mínimo: 1

Máximo: 10000

BisectBatchOnFunctionError

Si la función devuelve un error, divida el lote en dos y vuelva a intentarlo.

Tipo: Booleano

Obligatorio: no

Compatibilidad con CloudFormation: esta propiedad se transfiere directamente a la propiedad BisectBatchOnFunctionError de un recurso AWS::Lambda::EventSourceMapping.

DestinationConfig

Una cola de Amazon Simple Queue Service (Amazon SQS) o un destino de tema de Amazon Simple Notification Service (Amazon SNS) para registros descartados.

Tipo: DestinationConfig

Obligatorio: no

Compatibilidad con CloudFormation: esta propiedad se transfiere directamente a la propiedad DestinationConfig de un recurso AWS::Lambda::EventSourceMapping.

Enabled

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

Tipo: Booleano

Obligatorio: no

Compatibilidad con CloudFormation: esta propiedad se transfiere directamente a la propiedad Enabled de un recurso AWS::Lambda::EventSourceMapping.

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

Compatibilidad con CloudFormation: esta propiedad se transfiere directamente a la propiedad FilterCriteria de un recurso AWS::Lambda::EventSourceMapping.

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

Compatibilidad con CloudFormation: esta propiedad se transfiere directamente a la propiedad FunctionResponseTypes de un recurso AWS::Lambda::EventSourceMapping.

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

Compatibilidad con CloudFormation: esta propiedad se transfiere directamente a la propiedad KmsKeyArn de un recurso AWS::Lambda::EventSourceMapping.

MaximumBatchingWindowInSeconds

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

Tipo: Entero

Obligatorio: no

Compatibilidad con CloudFormation: esta propiedad se transfiere directamente a la propiedad MaximumBatchingWindowInSeconds de un recurso AWS::Lambda::EventSourceMapping.

MaximumRecordAgeInSeconds

La antigüedad máxima de un registro que Lambda envía a una función para su procesamiento.

Tipo: entero

Obligatorio: no

Compatibilidad con CloudFormation: esta propiedad se transfiere directamente a la propiedad MaximumRecordAgeInSeconds de un recurso AWS::Lambda::EventSourceMapping.

MaximumRetryAttempts

El número máximo de veces que se debe volver a intentar cuando la función devuelve un error.

Tipo: entero

Obligatorio: no

Compatibilidad con CloudFormation: esta propiedad se transfiere directamente a la propiedad MaximumRetryAttempts de un recurso AWS::Lambda::EventSourceMapping.

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

Compatibilidad con CloudFormation: esta propiedad se transfiere directamente a la propiedad MetricsConfig de un recurso AWS::Lambda::EventSourceMapping.

ParallelizationFactor

El número de lotes de cada partición que se procesarán simultáneamente.

Tipo: entero

Obligatorio: no

Compatibilidad con CloudFormation: esta propiedad se transfiere directamente a la propiedad ParallelizationFactor de un recurso AWS::Lambda::EventSourceMapping.

StartingPosition

La posición en el flujo donde comienza la lectura.

  • AT_TIMESTAMP: especifique el tiempo a partir del cual comenzar la lectura de registros.

  • LATEST: registros nuevos de solo lectura.

  • TRIM_HORIZON: procese todos los registros disponibles.

Valores válidos: AT_TIMESTAMP | LATEST | TRIM_HORIZON

Tipo: cadena

Obligatorio: sí

Compatibilidad con CloudFormation: esta propiedad se transfiere directamente a la propiedad StartingPosition de un recurso AWS::Lambda::EventSourceMapping.

StartingPositionTimestamp

El tiempo a partir del cual comenzar la lectura, en segundos de tiempo Unix. Defina StartingPositionTimestamp cuando StartingPosition se especifica como AT_TIMESTAMP.

Tipo: Doble

Obligatorio: no

Compatibilidad con CloudFormation: esta propiedad se transfiere directamente a la propiedad StartingPositionTimestamp de un recurso AWS::Lambda::EventSourceMapping.

Stream

El nombre de recurso de Amazon (ARN) del flujo de datos un consumidor de flujos.

Tipo: cadena

Obligatorio: sí

Compatibilidad con CloudFormation: esta propiedad se transfiere directamente a la propiedad EventSourceArn de un recurso AWS::Lambda::EventSourceMapping.

TumblingWindowInSeconds

La duración, en segundos, de una ventana de procesamiento. El intervalo válido es de 1 a 900 (15 minutos).

Para más información, consulta Ventanas móviles en la Guía para desarrolladores de AWS Lambda.

Tipo: entero

Obligatorio: no

Compatibilidad con CloudFormation: esta propiedad se transfiere directamente a la propiedad TumblingWindowInSeconds de un recurso AWS::Lambda::EventSourceMapping.

Ejemplos

Evento de MetricsConfig

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

Origen de eventos de Kinesis

A continuación, se muestra un ejemplo de origen de evento de 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"]}'