EventBridgeRule

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

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

Sintaxe

Para declarar essa entidade em seu AWS Serverless Application Model (AWS SAM) modelo, use a seguinte sintaxe.

YAML

  DeadLetterConfig: DeadLetterConfig
  EventBusName: String
  Input: String
  InputPath: String
  InputTransformer: InputTransformer
  Pattern: EventPattern
  RetryPolicy: RetryPolicy
  RuleName: String 
  State: String
  Target: Target

Propriedades

DeadLetterConfig

Configure a fila do Amazon Simple Queue Service (AmazonSQS) para a qual 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 Lambda que não existe ou quando não há permissões suficientes para invocar EventBridge a função Lambda. Para obter mais informações, consulte Política de repetição de eventos e uso de filas de mensagens mortas no Guia do usuário da 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 DeadLetterQueue propriedade da função, consulte Filas de letras mortas no AWS Lambda Guia do desenvolvedor.

Tipo: DeadLetterConfig

Obrigatório: não

AWS CloudFormation compatibilidade: essa propriedade é semelhante à DeadLetterConfig propriedade do tipo de AWS::Events::Rule Target dados. A ferramenta AWS SAM versão desta propriedade inclui subpropriedades adicionais, caso você queira AWS SAM para criar a fila de mensagens mortas para você.

EventBusName

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

Type: string

Obrigatório: não

Padrão: barramento de eventos padrão

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

Input

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

Tipo: string

Obrigatório: não

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

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

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

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 EventBridge de entrada da Amazon no Guia EventBridge do usuário da Amazon.

Tipo: InputTransformer

Obrigatório: não

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

Pattern

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

Tipo: EventPattern

Obrigatório: Sim

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

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 mortas no Guia do usuário da Amazon. EventBridge

Tipo: RetryPolicy

Obrigatório: não

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

RuleName

O nome da regra.

Tipo: string

Obrigatório: não

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

State

O estado da regra.

Valores aceitos: DISABLED | ENABLED

Tipo: string

Obrigatório: não

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

Target

A ferramenta AWS recurso que é EventBridge invocado 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 AWS SAM gera o ID lógico do alvo.

Tipo: Target

Obrigatório: não

AWS CloudFormation compatibilidade: essa propriedade é semelhante à Targets propriedade de um AWS::Events::Rule recurso. Amazon EC2 RebootInstances API callé um exemplo de uma propriedade alvo. A ferramenta AWS SAM A versão 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