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á.
O objeto que descreve um tipo de origem do evento MSK
. Para obter mais informações, consulte Como usar AWS Lambda com o Amazon MSK no Guia do AWS Lambda desenvolvedor.
AWS Serverless Application Model (AWS SAM) gera um AWS::Lambda::EventSourceMappingrecurso quando esse tipo de evento é definido.
Sintaxe
Para declarar essa entidade em seu AWS SAM modelo, use a sintaxe a seguir.
YAML
ConsumerGroupId: String
DestinationConfig: DestinationConfig
FilterCriteria: FilterCriteria
KmsKeyArn: String
MaximumBatchingWindowInSeconds: Integer
ProvisionedPollerConfig: ProvisionedPollerConfig
SourceAccessConfigurations: SourceAccessConfigurations
StartingPosition: String
StartingPositionTimestamp: Double
Stream: String
Topics: List
Propriedades
-
ConsumerGroupId
-
Uma string que configura como os eventos serão lidos nos tópicos do Kafka.
Type: string
Obrigatório: não
AWS CloudFormation compatibilidade: essa propriedade é passada diretamente para a
AmazonManagedKafkaConfiguration
propriedade de umAWS::Lambda::EventSourceMapping
recurso. -
DestinationConfig
-
Um objeto de configuração que especifica o destino de um evento depois que o Lambda processá-lo.
Use essa propriedade para especificar o destino de invocações com falha da fonte de eventos do Amazon MSK.
Digite: DestinationConfig
Obrigatório: não
AWS CloudFormation compatibilidade: essa propriedade é passada diretamente para a
DestinationConfig
propriedade de umAWS::Lambda::EventSourceMapping
recurso. -
FilterCriteria
-
Um objeto que define os critérios que determinam 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 umAWS::Lambda::EventSourceMapping
recurso. -
KmsKeyArn
-
O nome do recurso da Amazon (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 umAWS::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 umAWS::Lambda::EventSourceMapping
recurso. -
ProvisionedPollerConfig
-
Configuração para aumentar a quantidade de pollers usados para computar mapeamentos de origem de eventos. Essa configuração permite um mínimo de 1 poller e um máximo de 20 pollers. Para obter um exemplo, consulteProvisionedPollerConfig exemplo.
Digite: ProvisionedPollerConfig
Obrigatório: não
AWS CloudFormation compatibilidade: essa propriedade é passada diretamente para a
ProvisionedPollerConfig
propriedade de umAWS::Lambda::EventSourceMapping
recurso. -
SourceAccessConfigurations
-
Uma matriz do protocolo de autenticação, os componentes da VPC ou o host virtual para proteger e definir a fonte de eventos.
Valores válidos:
CLIENT_CERTIFICATE_TLS_AUTH
Tipo: lista de SourceAccessConfiguration
Obrigatório: não
AWS CloudFormation compatibilidade: essa propriedade é passada diretamente para a
SourceAccessConfigurations
propriedade de umAWS::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: não
AWS CloudFormation compatibilidade: essa propriedade é passada diretamente para a
StartingPosition
propriedade de umAWS::Lambda::EventSourceMapping
recurso. -
-
StartingPositionTimestamp
-
O tempo a partir do qual iniciar a leitura, em segundos no horário do Unix. Defina
StartingPositionTimestamp
quandoStartingPosition
é especificado como .AT_TIMESTAMP
Tipo: duplo
Obrigatório: não
AWS CloudFormation compatibilidade: essa propriedade é passada diretamente para a
StartingPositionTimestamp
propriedade de umAWS::Lambda::EventSourceMapping
recurso. -
Stream
-
O nome de recurso da Amazon (ARN) do fluxo de dados ou um consumidor de fluxo.
Type: string
Obrigatório: Sim
AWS CloudFormation compatibilidade: essa propriedade é passada diretamente para a
EventSourceArn
propriedade de umAWS::Lambda::EventSourceMapping
recurso. -
Topics
-
O nome do tópico do Kafka.
Tipo: lista
Obrigatório: Sim
AWS CloudFormation compatibilidade: essa propriedade é passada diretamente para a
Topics
propriedade de umAWS::Lambda::EventSourceMapping
recurso.
Exemplos
ProvisionedPollerConfig exemplo
ProvisionedPollerConfig:
MinimumPollers: 1
MaximumPollers: 20
Exemplo do Amazon MSK para cluster existente
Veja a seguir um exemplo de um tipo de fonte de MSK
evento para um cluster Amazon MSK que já existe em um Conta da 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
Exemplo do Amazon MSK para cluster declarado no mesmo modelo
Veja a seguir um exemplo de um tipo de fonte de MSK
evento para um cluster Amazon MSK declarado no mesmo arquivo de modelo.
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