EventBridgeRule

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

AWS SAM genera un AWS::Events::Rulerisorsa quando questo tipo di evento è impostato. AWS SAM crea anche una AWS::Lambda::Permission risorsa, necessaria per EventBridgeRule poter chiamare Lambda.

Sintassi

Per dichiarare questa entità nel tuo AWS Serverless Application Model (AWS SAM) modello, usa 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 (AmazonSQS) in cui EventBridge invia gli eventi dopo una chiamata di destinazione non riuscita. L'invocazione può fallire, ad esempio, quando si invia un evento a una funzione Lambda che non esiste o quando EventBridge le autorizzazioni sono insufficienti per richiamare la funzione Lambda. Per ulteriori informazioni, consulta la politica di riprova degli eventi e l'utilizzo delle code di lettere morte nella Amazon User Guide. EventBridge

Nota

Il tipo di AWS::Serverless::Function risorsa ha un tipo di dati simileDeadLetterQueue, che gestisce gli errori che si verificano dopo una chiamata riuscita della funzione Lambda di destinazione. Esempi di questi tipi di errori includono la limitazione Lambda o gli errori restituiti dalla funzione di destinazione Lambda. Per ulteriori informazioni sulla DeadLetterQueue proprietà della funzione, vedete Dead-letter queues in AWS Lambda Guida per gli sviluppatori.

Tipo: DeadLetterConfig

Required: No

AWS CloudFormation compatibilità: questa proprietà è simile alla DeadLetterConfig proprietà del tipo di AWS::Events::Rule Target dati. Il AWS SAM la versione di questa proprietà include sottoproprietà aggiuntive, nel caso in cui lo desideri AWS SAM per creare la coda delle lettere morte per te.

EventBusName

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

Tipo: Stringa

Required: No

Predefinito: bus di eventi predefinito

AWS CloudFormation compatibilità: questa proprietà viene passata direttamente alla EventBusName proprietà di una AWS::Events::Rule risorsa.

Input

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

Tipo: Stringa

Required: No

AWS CloudFormation compatibilità: questa proprietà viene passata direttamente alla Input proprietà di una AWS::Events::Rule Target risorsa.

InputPath

Quando non vuoi passare l'intero evento corrispondente alla destinazione, usa la InputPath proprietà per descrivere quale parte dell'evento trasmettere.

Tipo: Stringa

Required: No

AWS CloudFormation compatibilità: questa proprietà viene passata direttamente alla InputPath proprietà di una AWS::Events::Rule Target risorsa.

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, consulta Amazon EventBridge Input Transformation nella Amazon EventBridge User Guide.

Tipo: InputTransformer

Required: No

AWS CloudFormation compatibilità: questa proprietà viene passata direttamente alla InputTransformer proprietà di un tipo di AWS::Events::Rule Target dati.

Pattern

Descrive quali eventi vengono instradati nella destinazione specificata. Per ulteriori informazioni, consulta EventBridgegli eventi e i modelli di EventBridge eventi di Amazon nella Amazon EventBridge User Guide.

Tipo: EventPattern

Campo obbligatorio: sì

AWS CloudFormation compatibilità: questa proprietà viene passata direttamente alla EventPattern proprietà di una AWS::Events::Rule risorsa.

RetryPolicy

Un oggetto RetryPolicy che include informazioni sulle impostazioni dei criteri di nuovi tentativi. Per ulteriori informazioni, consulta la politica di riprova degli eventi e l'utilizzo delle code di lettere morte nella Amazon User Guide. EventBridge

Tipo: RetryPolicy

Required: No

AWS CloudFormation compatibilità: questa proprietà viene passata direttamente alla RetryPolicy proprietà del tipo di AWS::Events::Rule Target dati.

RuleName

Nome della regola .

Tipo: Stringa

Required: No

AWS CloudFormation compatibilità: questa proprietà viene passata direttamente alla Name proprietà di una AWS::Events::Rule risorsa.

State

Lo stato della regola.

Valori accettati: DISABLED | ENABLED

Tipo: Stringa

Required: No

AWS CloudFormation compatibilità: questa proprietà viene passata direttamente alla State proprietà di una AWS::Events::Rule risorsa.

Target

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

Tipo: Target

Required: No

AWS CloudFormation compatibilità: questa proprietà è simile alla Targets proprietà di una AWS::Events::Rule risorsa. Amazon EC2 RebootInstances API callè un esempio di proprietà di destinazione. Il AWS SAM la versione di questa proprietà consente solo di specificare l'ID logico di una singola destinazione.

Esempi

EventBridgeRule

Di seguito è riportato un esempio di tipo di origine di EventBridgeRule 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