EventBridgeRule - AWS Serverless Application Model
SintaxePropriedadesExemplos

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

EventBridgeRule

O objeto que descreve um tipo de fonte de evento EventBridgeRule, que define sua função sem servidor como o destino de uma regra do Amazon EventBridge. Para obter mais informações, consulte O que é o Amazon EventBridge? no Manual do usuário do Amazon EventBridge.

O AWS SAM gera um recurso AWS::Events::Rule quando esse tipo de evento é definido. O AWS SAM também cria um recurso AWS::Lambda::Permission, que é necessário para que EventBridgeRule possa chamar o Lambda.

Sintaxe

Para declarar esta entidade no modelo do AWS Serverless Application Model (AWS SAM), use a seguinte sintaxe:

Propriedades

DeadLetterConfig

Configure a fila do Amazon Simple Queue Service (Amazon SQS) para a qual o EventBridge envia eventos após uma falha na invocação de destino. A invocação pode falhar, por exemplo, ao enviar um evento para uma função do Lambda que não existe ou quando o EventBridge não tem permissões suficientes para invocar a função do Lambda. Para obter mais informações, consulte Política de repetição de eventos e uso de filas de mensagens não entregues no Guia do usuário do Amazon EventBridge.

nota

O tipo de recurso AWS::Serverless::Function tem um tipo de dados semelhante, DeadLetterQueue, que lida com falhas que ocorrem após a invocação bem-sucedida da função do Lambda de destino. Exemplos desses tipos de falhas incluem controle de utilização do Lambda ou erros retornados pela função de destino do Lambda. Para obter mais informações sobre a propriedade DeadLetterQueue da função, consulte Filas de mensagens não entregues no Guia do desenvolvedor do AWS Lambda.

Tipo: DeadLetterConfig

Obrigatório: não

Compatibilidade CloudFormation: Essa propriedade é semelhante à propriedade DeadLetterConfig do tipo de dados AWS::Events::Rule Target. A versão AWS SAM dessa propriedade inclui subpropriedades adicionais, caso você queira que o AWS SAM crie a fila de mensagens não entregues para você.

EventBusName

O barramento de eventos que deve ser associado a essa regra. Se você omitir essa propriedade, o AWS SAM usará o barramento de eventos padrão.

Tipo: string

Obrigatório: não

Padrão: barramento de eventos padrão

Compatibilidade CloudFormation: essa propriedade é passada diretamente para a propriedade EventBusName de um recurso AWS::Events::Rule.

Input

Texto JSON válido passado para o destino. Se você usar essa propriedade, nada do próprio texto do evento é passado para o destino.

Tipo: string

Obrigatório: não

Compatibilidade CloudFormation: essa propriedade é passada diretamente para a propriedade Input de um recurso AWS::Events::Rule Target.

InputPath

Quando você não deseja passar todo o evento correspondente ao destino, a propriedade InputPath descreve qual parte do evento passar.

Tipo: string

Obrigatório: não

Compatibilidade CloudFormation: essa propriedade é passada diretamente para a propriedade InputPath de um recurso AWS::Events::Rule Target.

InputTransformer

Configurações para permitir que você forneça entrada personalizada para um destino com base em determinados dados de evento. Você pode extrair um ou mais pares de valor-chave do evento e usar esses dados para enviar a entrada personalizada para o destino. Para obter mais informações, consulte Transformação de entrada do Amazon EventBridge no Guia do usuário do Amazon EventBridge.

Tipo: InputTransformer

Obrigatório: não

Compatibilidade CloudFormation: essa propriedade é passada diretamente para a propriedade InputTransformer de um tipo de dados AWS::Events::Rule Target.

Pattern

Descreve quais eventos são roteados para o destino especificado. Para obter mais informações, consulte Eventos do Amazon EventBridge e Padrões de eventos do EventBridge no Guia do usuário do Amazon EventBridge.

Tipo: EventPattern

Obrigatório: Sim

Compatibilidade CloudFormation: essa propriedade é passada diretamente para a propriedade EventPattern de um recurso AWS::Events::Rule.

RetryPolicy

Um objeto RetryPolicy que inclui informações sobre as configurações de política de repetição. Para obter mais informações, consulte Política de repetição de eventos e uso de filas de mensagens não entregues no Guia do usuário do Amazon EventBridge.

Type: RetryPolicy

Obrigatório: não

Compatibilidade CloudFormation: essa propriedade é passada diretamente para a propriedade RetryPolicy do tipo de dados AWS::Events::Rule Target.

RuleName

O nome da regra do .

Tipo: string

Obrigatório: não

Compatibilidade CloudFormation: essa propriedade é passada diretamente para a propriedade Name de um recurso AWS::Events::Rule.

State

O estado da regra.

Valores aceitos: DISABLED | ENABLED | ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS

Tipo: string

Obrigatório: não

Compatibilidade CloudFormation: essa propriedade é passada diretamente para a propriedade State de um recurso AWS::Events::Rule.

Target

O recurso AWS que o EventBridge invoca quando uma regra é acionada. Você pode usar essa propriedade para especificar a ID lógica do destino. Se essa propriedade não for especificada, então o AWS SAM gera a ID lógica do destino.

Tipo: Target

Obrigatório: não

Compatibilidade do CloudFormation: essa propriedade é semelhante à propriedade Targets de um recurso AWS::Events::Rule. Amazon EC2 RebootInstances API call é um exemplo de propriedade de destino. A versão AWS SAM dessa propriedade só permite que você especifique a ID lógica de um único destino.

Exemplos

EventBridgeRule

O exemplo a seguir mostra o tipo de origem de um evento EventBridgeRule.

YAML

EBRule:
  Type: EventBridgeRule
  Properties:
    Input: '{"Key": "Value"}'
    Pattern:
      detail:
        state:
          - terminated
    RetryPolicy:
      MaximumRetryAttempts: 5
      MaximumEventAgeInSeconds: 900
    DeadLetterConfig:
      Type: SQS
      QueueLogicalId: EBRuleDLQ
    Target:
      Id: MyTarget