EventBridgeRule

Das Objekt, das einen EventBridgeRule Ereignisquellentyp beschreibt, der Ihre serverlose Funktion als Ziel einer EventBridge Amazon-Regel festlegt. Weitere Informationen finden Sie unter Was ist Amazon EventBridge? im EventBridge Amazon-Benutzerhandbuch.

AWS SAM generiert ein AWS::Events::RuleRessource, wenn dieser Ereignistyp gesetzt ist. AWS SAM erstellt auch eine AWS::Lambda::Permission Ressource, die benötigt wird, damit Lambda aufgerufen werden EventBridgeRule kann.

Syntax

Um diese Entität in Ihrem zu deklarieren AWS Serverless Application Model (AWS SAM) Vorlage, verwenden Sie die folgende Syntax.

YAML

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

Eigenschaften

DeadLetterConfig

Konfigurieren Sie die Amazon Simple Queue Service (AmazonSQS) -Warteschlange, über die Ereignisse nach einem fehlgeschlagenen Zielaufruf EventBridge gesendet werden. Der Aufruf kann beispielsweise fehlschlagen, wenn ein Ereignis an eine Lambda-Funktion gesendet wird, die nicht existiert, oder wenn EventBridge nicht genügend Berechtigungen zum Aufrufen der Lambda-Funktion vorhanden sind. Weitere Informationen finden Sie unter Richtlinien zur Wiederholung von Ereignissen und Verwenden von Warteschlangen mit unerlaubten Briefen im Amazon-Benutzerhandbuch. EventBridge

Anmerkung

Der AWS::Serverless::Function Ressourcentyp hat einen ähnlichen DatentypDeadLetterQueue, der Fehler behandelt, die nach einem erfolgreichen Aufruf der Lambda-Zielfunktion auftreten. Beispiele für diese Arten von Fehlern sind Lambda-Drosselung oder Fehler, die von der Lambda-Zielfunktion zurückgegeben werden. Weitere Informationen zur DeadLetterQueue Funktionseigenschaft finden Sie unter Warteschlangen mit unerlaubtem Text im AWS Lambda Leitfaden für Entwickler.

Typ: DeadLetterConfig

Required: No

AWS CloudFormation Kompatibilität: Diese Eigenschaft ähnelt der DeadLetterConfig Eigenschaft des AWS::Events::Rule Target Datentyps. Das Tool AWS SAM Die Version dieser Eigenschaft enthält zusätzliche Untereigenschaften, falls Sie möchten AWS SAM um die Warteschlange für unzustellbare Briefe für Sie zu erstellen.

EventBusName

Der Ereignisbus, der dieser Regel zugeordnet werden soll. Wenn Sie diese Eigenschaft weglassen, AWS SAM verwendet den Standard-Event-Bus.

Typ: Zeichenfolge

Required: No

Standard: Standard-Event-Bus

AWS CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an die EventBusName Eigenschaft einer AWS::Events::Rule Ressource übergeben.

Input

Gültiger JSON Text wurde an das Ziel übergeben. Wenn Sie diese Eigenschaft verwenden, wird nichts aus dem Ereignistext selbst an das Ziel weitergeleitet.

Typ: Zeichenfolge

Required: No

AWS CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an die Input Eigenschaft einer AWS::Events::Rule Target Ressource übergeben.

InputPath

Wenn Sie nicht das gesamte übereinstimmende Ereignis an das Ziel übergeben möchten, verwenden Sie die InputPath Eigenschaft, um zu beschreiben, welcher Teil des Ereignisses übergeben werden soll.

Typ: Zeichenfolge

Required: No

AWS CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an die InputPath Eigenschaft einer AWS::Events::Rule Target Ressource übergeben.

InputTransformer

Einstellungen, mit denen Sie benutzerdefinierte Eingaben für ein Ziel basierend auf bestimmten Ereignisdaten bereitstellen können. Sie können einzelne oder mehrere Schlüssel-Wert-Paare aus dem Ereignis extrahieren und diese Daten dann verwenden, um benutzerdefinierte Eingaben an das Ziel zu senden. Weitere Informationen finden Sie unter Amazon EventBridge Input Transformation im EventBridge Amazon-Benutzerhandbuch.

Typ: InputTransformer

Required: No

AWS CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an die InputTransformer Eigenschaft eines AWS::Events::Rule Target Datentyps übergeben.

Pattern

Beschreibt, welche Ereignisse an das angegebene Ziel weitergeleitet werden. Weitere Informationen finden Sie unter EventBridgeAmazon-Ereignisse und EventBridge -Ereignismuster im EventBridge Amazon-Benutzerhandbuch.

Typ: EventPattern

Erforderlich: Ja

AWS CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an die EventPattern Eigenschaft einer AWS::Events::Rule Ressource übergeben.

RetryPolicy

Ein RetryPolicy-Objekt, das Informationen zu den Richtlinieneinstellungen für Wiederholungsversuche enthält. Weitere Informationen finden Sie unter Richtlinien zur Wiederholung von Ereignissen und Verwenden von Warteschlangen mit unerlaubten Briefen im Amazon-Benutzerhandbuch. EventBridge

Typ: RetryPolicy

Required: No

AWS CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an die RetryPolicy Eigenschaft des AWS::Events::Rule Target Datentyps übergeben.

RuleName

Der Name der Regel.

Typ: Zeichenfolge

Required: No

AWS CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an die Name Eigenschaft einer AWS::Events::Rule Ressource übergeben.

State

Der Status der Regel.

Zulässige Werte: DISABLED | ENABLED

Typ: Zeichenfolge

Required: No

AWS CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an die State Eigenschaft einer AWS::Events::Rule Ressource übergeben.

Target

Das Tool AWS Ressource, die EventBridge aufgerufen wird, wenn eine Regel ausgelöst wird. Sie können diese Eigenschaft verwenden, um die logische ID des Ziels anzugeben. Wenn diese Eigenschaft nicht angegeben ist, dann AWS SAM generiert die logische ID des Ziels.

Typ: Ziel

Required: No

AWS CloudFormation Kompatibilität: Diese Eigenschaft ähnelt der Targets Eigenschaft einer AWS::Events::Rule Ressource. Amazon EC2 RebootInstances API callist ein Beispiel für eine Zieleigenschaft. Das Tool AWS SAM In einer Version dieser Eigenschaft können Sie nur die logische ID eines einzelnen Ziels angeben.

Beispiele

EventBridgeRule

Im Folgenden finden Sie ein Beispiel für einen EventBridgeRule Ereignisquellentyp.

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