EventBridgeRule

Das Objekt, das einen EventBridgeRule Ereignisquellentyp beschreibt, der Ihren Zustandsmaschine als Ziel für eine EventBridge Amazon-Regel festlegt. Weitere Informationen finden Sie unter Was ist Amazon EventBridge? im EventBridge Amazon-Benutzerhandbuch.

AWS SAM generiert eine AWS::Events::RuleRessource, wenn dieser Ereignistyp festgelegt ist.

Syntax

Verwenden Sie die folgende Syntax, um diese Entität in Ihrer Vorlage AWS Serverless Application Model (AWS SAM) zu deklarieren.

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 (Amazon SQS) -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 die Berechtigungen zum Aufrufen der Lambda-Funktion nicht ausreichen. Weitere Informationen finden Sie unter Richtlinien zur Wiederholung von Ereignissen und Verwenden von Warteschlangen mit unerlaubten Briefen im Amazon-Benutzerhandbuch. EventBridge

Typ: DeadLetterConfig

Required: No

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

EventBusName

Der Ereignisbus, der dieser Regel zugeordnet werden soll. Wenn Sie diese Eigenschaft weglassen, wird der AWS SAM Standardereignisbus verwendet.

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 Ereignisse und Ereignismuster EventBridge 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.

Gültige 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

Die 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, wird die logische ID des Ziels AWS SAM generiert.

Typ: Ziel

Required: No

AWS CloudFormation Kompatibilität: Diese Eigenschaft ähnelt der Targets Eigenschaft einer AWS::Events::Rule Ressource. In der AWS SAM 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