EventBridgeRule

L'oggetto che descrive un tipo di origine diEventBridgeRule eventi, che imposta la tua funzione serverless come destinazione di una EventBridge regola Amazon. Per ulteriori informazioni, consulta Che cos'è Amazon EventBridge? nella Amazon EventBridge User Guide.

AWS SAMgenera una AWS::Events::Rulerisorsa quando viene impostato questo tipo di evento.

Sintassi

Per dichiarare questa entità nel modelloAWS Serverless Application Model (AWS SAM), utilizzare la sintassi seguente.

YAML

  DeadLetterConfig: DeadLetterConfig
  EventBusName: String
  Input: String
  Name: String
  InputPath: String
  Name: String
  Pattern: EventPattern
  RetryPolicy: RetryPolicy
  Target: Target

Proprietà

DeadLetterConfig

Configura la coda Amazon Simple Queue Service (Amazon SQS) dove EventBridge invia eventi dopo una chiamata di destinazione fallita. L'invocazione può fallire, ad esempio, quando si invia un evento a una funzione Lambda che non esiste o quando non EventBridge dispone di autorizzazioni sufficienti per richiamare la funzione Lambda. Per ulteriori informazioni, consulta la Criterio tentativi di eventi e sull'utilizzo delle dead-letter queue nella Guida per l' EventBridge utente di Amazon.

Nota

Il tipo diAWS::Serverless::Function risorsa ha un tipo di dati simileDeadLetterQueue, che gestisce gli errori che si verificano dopo aver richiamato con successo la funzione Lambda di destinazione. Esempi di questi tipi di errori includono la limitazione Lambda o gli errori restituiti dalla funzione target Lambda. Per ulteriori informazioni sullaDeadLetterQueue proprietà della funzione, consulta le code con lettere scadute delleAWS Lambda funzioni nella Guida per gliAWS Lambda sviluppatori.

Tipo: DeadLetterConfig

Required: No

AWS CloudFormationcompatibilità: questa proprietà è simile allaDeadLetterConfig proprietà del tipo diAWS::Events::RuleTarget dati. LaAWS SAM versione di questa proprietà include sottoproprietà aggiuntive, nel caso in cui desideriAWS SAM creare automaticamente la coda di lettere morte.

EventBusName

Il bus evento da associare a questa regola. Se ometti questa proprietà,AWS SAM utilizza il bus eventi predefinito.

Tipo: stringa

Required: No

Predefinito: bus eventi predefinito

AWS CloudFormationcompatibilità: questa proprietà viene passata direttamente allaEventBusName proprietà di unaAWS::Events::Rule risorsa.

Input

Testo JSON valido passato al target. Se utilizzi questa proprietà, al target non viene passata alcuna informazione sul testo dell'evento.

Tipo: stringa

Required: No

AWS CloudFormationcompatibilità: questa proprietà viene passata direttamente allaInput proprietà di unaAWS::Events::Rule Target risorsa.

InputPath

Se non desideri passare l'intero evento corrispondente al target, utilizza laInputPath proprietà per descrivere quale parte dell'evento passare.

Tipo: stringa

Required: No

AWS CloudFormationcompatibilità: questa proprietà viene passata direttamente allaInputPath proprietà di unaAWS::Events::Rule Target risorsa.

Name

Nome della regola .

Tipo: stringa

Required: No

AWS CloudFormationcompatibilità: questa proprietà viene passata direttamente allaName proprietà di unaAWS::Events::Rule risorsa.

Name

Nome della regola .

Tipo: stringa

Required: No

AWS CloudFormationcompatibilità: questa proprietà viene passata direttamente allaName proprietà di unaAWS::Events::Rule risorsa.

Pattern

Descrive quali eventi vengono instradati nella destinazione specificata. Per ulteriori informazioni, consulta Eventi e modelli di eventi EventBridge nella Guida per l' EventBridge utente di Amazon.

Tipo: EventPattern

Required: Yes

AWS CloudFormationcompatibilità: questa proprietà viene passata direttamente allaEventPattern proprietà di unaAWS::Events::Rule risorsa.

RetryPolicy

Un oggetto RetryPolicy che include informazioni sulle impostazioni dei criteri di nuovi tentativi. Per ulteriori informazioni, consulta la Criterio tentativi di eventi e sull'utilizzo delle dead-letter queue nella Guida per l' EventBridge utente di Amazon.

Tipo: RetryPolicy

Required: No

AWS CloudFormationcompatibilità: questa proprietà viene passata direttamente allaRetryPolicy proprietà del tipo diAWS::Events::RuleTarget dati.

Target

LaAWS risorsa che viene EventBridge invocata quando viene attivata una regola. È possibile utilizzare questa proprietà per specificare l'ID logico della destinazione. Se questa proprietà non è specificata,AWS SAM genera l'ID logico della destinazione.

Tipo: bersaglio

Required: No

AWS CloudFormationcompatibilità: questa proprietà è simile allaTargets proprietà di unaAWS::Events::Rule risorsa. LaAWS SAM versione di questa proprietà consente solo di specificare l'ID logico di una singola destinazione.

Esempi

EventBridgeRule

Di seguito è illustrato un esempio di tipo di origine diEventBridgeRule eventi.

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