CloudWatchEvent

Das Objekt, das einen CloudWatchEvent Ereignisquellentyp beschreibt.

AWS Serverless Application Model (AWS SAM) generiert eine AWS::Events::RuleRessource, wenn dieser Ereignistyp gesetzt ist.

Wichtiger Hinweis: EventBridgeRule ist der bevorzugte Typ der Ereignisquelle, der anstelle von verwendet wirdCloudWatchEvent. EventBridgeRuleund CloudWatchEvent verwenden Sie denselben zugrunde liegenden Dienst, dieselbe API und dieselben AWS CloudFormation Ressourcen. AWS SAM Wird jedoch nur Unterstützung für neue Funktionen hinzufügenEventBridgeRule.

Syntax

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

YAML

  Enabled: Boolean
  EventBusName: String
  Input: String
  InputPath: String
  Pattern: EventPattern
  State: String

Eigenschaften

Enabled

Gibt an, ob die Regel aktiviert ist.

Um die Regel zu deaktivieren, setzen Sie diese Eigenschaft auffalse.

Anmerkung

Geben Sie entweder die State Eigenschaft Enabled oder an, aber nicht beide.

Typ: Boolesch

Required: No

AWS CloudFormation Kompatibilität: Diese Eigenschaft ähnelt der State Eigenschaft einer AWS::Events::Rule Ressource. Wenn diese Eigenschaft auf true gesetzt ist, gilt sie AWS SAM als erfolgreichENABLED, andernfalls gilt sie als erfolgreichDISABLED.

EventBusName

Der Ereignisbus, der dieser Regel zugeordnet werden soll. Wenn Sie diese Eigenschaft weglassen, AWS SAM wird der Standard-Event-Bus 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.

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.

State

Der Status der Regel.

Zulässige Werte: DISABLED | ENABLED

Anmerkung

Geben Sie entweder die State Eigenschaft Enabled oder an, aber nicht beide.

Typ: Zeichenfolge

Required: No

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

Beispiele

CloudWatchEvent

Das Folgende ist ein Beispiel für einen CloudWatchEvent Ereignisquellentyp.

YAML

CWEvent:
  Type: CloudWatchEvent
  Properties:
    Enabled: false
    Input: '{"Key": "Value"}'
    Pattern:
      detail:
        state:
          - running