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

MSK

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

AWS Serverless Application Model (AWS SAM) genera un AWS::Lambda::EventSourceMappingrecurso cuando se establece este tipo de evento.

Sintaxis

Para declarar esta entidad en la AWS SAM plantilla, utilice la siguiente sintaxis.

Propiedades

ConsumerGroupId

Una cadena que configura cómo se leerán los eventos de los temas de Kafka.

Tipo: cadena

Obligatorio: no

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

DestinationConfig

Un objeto de configuración que especifica el destino de un evento después de que Lambda lo procese.

Utilice esta propiedad para especificar el destino de las invocaciones fallidas desde la fuente de MSK eventos de Amazon.

Tipo: DestinationConfig

Obligatorio: no

AWS CloudFormation compatibilidad: esta propiedad se pasa directamente a la DestinationConfig 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, consulte Filtrado de eventos de AWS Lambda en la Guía para desarrolladores de AWS Lambda .

Tipo: FilterCriteria

Obligatorio: no

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

KmsKeyArn

El nombre del recurso de Amazon (ARN) de la clave para cifrar la información relacionada con este evento.

Tipo: cadena

Obligatorio: no

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

MaximumBatchingWindowInSeconds

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

Tipo: Entero

Obligatorio: no

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

SourceAccessConfigurations

Conjunto del protocolo de autenticación, VPC los componentes o el host virtual para proteger y definir el origen del evento.

Valores válidos: CLIENT_CERTIFICATE_TLS_AUTH

Tipo: Lista de SourceAccessConfiguration

Obligatorio: no

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

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: no

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

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

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

Stream

El nombre del recurso de Amazon (ARN) de la transmisión de datos o de un consumidor de la transmisión.

Tipo: cadena

Obligatorio: sí

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

Topics

El nombre del tema de Kafka.

Tipo: lista

Obligatorio: sí

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

Ejemplos

MSKEjemplo de Amazon para un clúster existente

El siguiente es un ejemplo de un tipo de fuente de MSK eventos para un MSK clúster de Amazon que ya existe en un Cuenta de AWS.

YAML

Events:
  MSKEvent:
    Type: MSK
    Properties:
      StartingPosition: LATEST
      Stream: arn:aws:kafka:us-east-1:012345678012:cluster/exampleClusterName/abcdefab-1234-abcd-5678-cdef0123ab01-2
      Topics:
        - MyTopic

MSKEjemplo de Amazon para un clúster declarado en la misma plantilla

El siguiente es un ejemplo de un tipo de fuente de MSK eventos para un MSK clúster de Amazon que se declara en el mismo archivo de plantilla.

YAML

Events:
  MSKEvent:
    Type: MSK
    Properties:
      StartingPosition: LATEST
      Stream:
        Ref: MyMskCluster   # This must be the name of an MSK cluster declared in the same template file
      Topics:
        - MyTopic