EventBridgeRule

L'oggetto che descrive unEventBridgeRuletipo di origine dell'evento, che imposta la tua funzione serverless come destinazione di AmazonEventBridgeregola. Per ulteriori informazioni, vedereChe cos'è AmazonEventBridge?nelAmazonEventBridgeGuida per l'utente.

AWS SAMgenera unAWS::Events::Rulerisorsa quando questo tipo di evento è impostato.

Sintassi

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

YAML

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

Proprietà

DeadLetterConfig

Configura la coda Amazon Simple Queue Service (Amazon SQS) doveEventBridgeinvia eventi dopo una chiamata al bersaglio non riuscita. L'invocazione può fallire, ad esempio, quando si invia un evento a una funzione Lambda che non esiste o quandoEventBridgedispone di autorizzazioni insufficienti per richiamare la funzione Lambda. Per ulteriori informazioni, vederePolitica di ripetizione degli eventi e utilizzo di code di lettere non consentitenelAmazonEventBridgeGuida per l'utente.

Nota

LaAWS::Serverless::Functionil tipo di risorsa ha un tipo di dati simile,DeadLetterQueue, che gestisce gli errori che si verificano dopo la corretta chiamata della funzione Lambda di destinazione. Esempi di questi tipi di errori includono il throttling Lambda o gli errori restituiti dalla funzione di destinazione Lambda. Per ulteriori informazioni sulla funzioneDeadLetterQueueproprietà, vediAWS Lambdacode di lettere morte della funzionenelAWS LambdaGuida per gli sviluppatori.

Tipo:DeadLetterConfig

Required: No

AWS CloudFormationcompatibilità: Questa proprietà è simile aDeadLetterConfigproprietà delAWS::Events::Rule Targettipo di dati. LaAWS SAMla versione di questa proprietà include sottoproprietà aggiuntive, nel caso in cui lo desideriAWS SAMper creare la coda delle lettere morte per te.

EventBusName

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

Tipo: stringa

Required: No

Predefinito: bus eventi predefinito

AWS CloudFormationcompatibilità: Questa proprietà viene passata direttamente alEventBusNameproprietà di unAWS::Events::Rulerisorsa.

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 alInputproprietà di unAWS::Events::Rule Targetrisorsa.

InputPath

Quando non vuoi passare l'intero evento abbinato al bersaglio, usa ilInputPathproprietà per descrivere quale parte dell'evento passare.

Tipo: stringa

Required: No

AWS CloudFormationcompatibilità: Questa proprietà viene passata direttamente alInputPathproprietà di unAWS::Events::Rule Targetrisorsa.

InputTransformer

Impostazioni che consentono di fornire input personalizzato a un target in base a determinati dati di eventi. Puoi estrarre una o più coppie chiave-valore dall'evento e quindi utilizzare tali dati per l'invio di input personalizzato al target. Per ulteriori informazioni, vedereAmazonEventBridgetrasformazione dell'inputnelAmazonEventBridgeGuida per l'utente.

Tipo:InputTransformer

Required: No

AWS CloudFormationcompatibilità: Questa proprietà viene passata direttamente alInputTransformerproprietà di unAWS::Events::Rule Targettipo di dati.

Pattern

Descrive quali eventi vengono instradati nella destinazione specificata. Per ulteriori informazioni, vedereAmazonEventBridgeeventieEventBridgemodelli di eventinelAmazonEventBridgeGuida per l'utente.

Tipo:EventPattern

Required: Yes

AWS CloudFormationcompatibilità: Questa proprietà viene passata direttamente alEventPatternproprietà di unAWS::Events::Rulerisorsa.

RetryPolicy

Un oggetto RetryPolicy che include informazioni sulle impostazioni dei criteri di nuovi tentativi. Per ulteriori informazioni, vederePolitica di ripetizione degli eventi e utilizzo di code di lettere non consentitenelAmazonEventBridgeGuida per l'utente.

Tipo:RetryPolicy

Required: No

AWS CloudFormationcompatibilità: Questa proprietà viene passata direttamente alRetryPolicyproprietà delAWS::Events::Rule Targettipo di dati.

RuleName

Nome della regola .

Tipo: stringa

Required: No

AWS CloudFormationcompatibilità: Questa proprietà viene passata direttamente alNameproprietà di unAWS::Events::Rulerisorsa.

State

Lo stato della regola.

Valori accettati:DISABLED | ENABLED

Tipo: stringa

Required: No

AWS CloudFormationcompatibilità: Questa proprietà viene passata direttamente alState proprietà di unAWS::Events::Rulerisorsa.

Target

LaAWSrisorsa cheEventBridgerichiama quando viene attivata una regola. È possibile utilizzare questa proprietà per specificare l'ID logico della destinazione. Se questa proprietà non è specificata,AWS SAMgenera l'ID logico della destinazione.

Tipo: Target

Required: No

AWS CloudFormationcompatibilità: Questa proprietà è simile aTargetsproprietà di unAWS::Events::Rulerisorsa. LaAWS SAMla versione di questa proprietà consente solo di specificare l'ID logico di una singola destinazione.

Esempi

EventBridgeRule

Di seguito è riportato un esempio diEventBridgeRuletipo di origine dell'evento.

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