Kinesis

L'objet décrivant un type de source d'événement Kinesis. Pour plus d'informations, consultez la section Utilisation AWS Lambda avec Amazon Kinesis dans le Guide du AWS Lambda développeur.

AWS SAM génère une AWS::Lambda::EventSourceMappingressource lorsque ce type d'événement est défini.

Syntaxe

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

YAML

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

Propriétés

BatchSize

Nombre maximum d'éléments à récupérer dans un seul lot.

Type : entier

Obligatoire : non

Par défaut : 100

AWS CloudFormation compatibilité : cette propriété est transmise directement à la BatchSize propriété d'une AWS::Lambda::EventSourceMapping ressource.

Minimum : 1

Maximum : 10000

BisectBatchOnFunctionError

Si la fonction renvoie une erreur, fractionnez le lot en deux et recommencez.

Type : valeur booléenne

Obligatoire : non

AWS CloudFormation compatibilité : cette propriété est transmise directement à la BisectBatchOnFunctionError propriété d'une AWS::Lambda::EventSourceMapping ressource.

DestinationConfig

Une file d'attente Amazon Simple Queue Service (AmazonSQS) ou une destination de rubrique Amazon Simple Notification Service (AmazonSNS) pour les enregistrements supprimés.

Type : DestinationConfig

Obligatoire : non

AWS CloudFormation compatibilité : cette propriété est transmise directement à la DestinationConfig propriété d'une AWS::Lambda::EventSourceMapping ressource.

Enabled

Désactive le mappage de source d'événement pour suspendre l'interrogation et l'appel.

Type : valeur booléenne

Obligatoire : non

AWS CloudFormation compatibilité : cette propriété est transmise directement à la Enabled propriété d'une AWS::Lambda::EventSourceMapping ressource.

FilterCriteria

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 dans le AWS Lambda Manuel du développeur.

Type : FilterCriteria

Obligatoire : non

AWS CloudFormation compatibilité : cette propriété est transmise directement à la FilterCriteria propriété d'une AWS::Lambda::EventSourceMapping ressource.

FunctionResponseTypes

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 dans le Guide du développeur AWS Lambda .

Valeurs valides : ReportBatchItemFailures

Type : liste

Obligatoire : non

AWS CloudFormation compatibilité : cette propriété est transmise directement à la FunctionResponseTypes propriété d'une AWS::Lambda::EventSourceMapping ressource.

KmsKeyArn

Le nom de ressource Amazon (ARN) de la clé permettant de chiffrer les informations relatives à cet événement.

Type : chaîne

Obligatoire : non

AWS CloudFormation compatibilité : cette propriété est transmise directement à la KmsKeyArn propriété d'une AWS::Lambda::EventSourceMapping ressource.

MaximumBatchingWindowInSeconds

Intervalle de temps maximal (en secondes) pour collecter des enregistrements avant d’invoquer la fonction.

Type : entier

Obligatoire : non

AWS CloudFormation compatibilité : cette propriété est transmise directement à la MaximumBatchingWindowInSeconds propriété d'une AWS::Lambda::EventSourceMapping ressource.

MaximumRecordAgeInSeconds

L'âge maximal d'une demande que Lambda envoie à une fonction pour traitement.

Type : entier

Obligatoire : non

AWS CloudFormation compatibilité : cette propriété est transmise directement à la MaximumRecordAgeInSeconds propriété d'une AWS::Lambda::EventSourceMapping ressource.

MaximumRetryAttempts

Nombre maximum de tentatives autorisées lorsque la fonction renvoie une erreur.

Type : entier

Obligatoire : non

AWS CloudFormation compatibilité : cette propriété est transmise directement à la MaximumRetryAttempts propriété d'une AWS::Lambda::EventSourceMapping ressource.

ParallelizationFactor

Le nombre de lots à traiter simultanément à partir de chaque partition.

Type : entier

Obligatoire : non

AWS CloudFormation compatibilité : cette propriété est transmise directement à la ParallelizationFactor propriété d'une AWS::Lambda::EventSourceMapping ressource.

StartingPosition

Position de début de la lecture dans le flux.

• AT_TIMESTAMP : spécifier l'heure à partir de laquelle la lecture des enregistrements doit commencer.

• LATEST : lire uniquement les nouveaux enregistrements.

• TRIM_HORIZON : traiter tous les enregistrements disponibles.

Valeurs valides : AT_TIMESTAMP | LATEST | TRIM_HORIZON

Type : chaîne

Obligatoire : oui

AWS CloudFormation compatibilité : cette propriété est transmise directement à la StartingPosition propriété d'une AWS::Lambda::EventSourceMapping ressource.

StartingPositionTimestamp

L'heure à partir de laquelle commencer la lecture, en secondes au format horaire Unix. Définissez StartingPositionTimestamp lorsque StartingPosition est défini sur AT_TIMESTAMP.

Type : double

Obligatoire : non

AWS CloudFormation compatibilité : cette propriété est transmise directement à la StartingPositionTimestamp propriété d'une AWS::Lambda::EventSourceMapping ressource.

Stream

Le nom de ressource Amazon (ARN) du flux de données ou d'un consommateur de flux.

Type : chaîne

Obligatoire : oui

AWS CloudFormation compatibilité : cette propriété est transmise directement à la EventSourceArn propriété d'une AWS::Lambda::EventSourceMapping ressource.

TumblingWindowInSeconds

La durée d'une fenêtre de traitement en secondes. La plage valide est de 1 à 900 (15 minutes).

Pour plus d'informations, consultez Fenêtres bascules dans le Guide du développeur AWS Lambda .

Type : entier

Obligatoire : non

AWS CloudFormation compatibilité : cette propriété est transmise directement à la TumblingWindowInSeconds propriété d'une AWS::Lambda::EventSourceMapping ressource.

Exemples

Source de l'événement Kinesis

Voici un exemple de source d'événement 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"]}'