CloudWatchEvent

L'objet décrivant un type de source d'événement CloudWatchEvent.

AWS Serverless Application Model (AWS SAM) génère une AWS::Events::Ruleressource lorsque ce type d'événement est défini.

Remarque importante : EventBridgeRule c'est le type de source d'événements préféré à utiliser, à la place deCloudWatchEvent. EventBridgeRuleet CloudWatchEvent utilisez le même service, la même API et les mêmes AWS CloudFormation ressources sous-jacents. Cependant, AWS SAM ajoutera la prise en charge des nouvelles fonctionnalités uniquement àEventBridgeRule.

Syntaxe

Pour déclarer cette entité dans votre modèle AWS Serverless Application Model (AWS SAM), utilisez la syntaxe suivante.

YAML

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

Propriétés

Enabled

Indique si la règle est activée.

Pour désactiver la règle, définissez cette propriété sur false.

Note

Spécifiez la propriété Enabled ou la propriété State, mais pas les deux.

Type : valeur booléenne

Obligatoire : non

AWS CloudFormation compatibilité : cette propriété est similaire à celle State d'une AWS::Events::Rule ressource. Si cette propriété est définie sur true thenENABLED, elle est AWS SAM transmise dans le cas contraireDISABLED.

EventBusName

Le bus d'événements à associer à cette règle. Si vous omettez cette propriété, AWS SAM utilise le bus d'événements par défaut.

Type : chaîne

Obligatoire : non

Par défaut : bus d'événement par défaut

AWS CloudFormation compatibilité : cette propriété est transmise directement à la EventBusName propriété d'une AWS::Events::Rule ressource.

Input

Texte JSON valide transmis à la cible. Si vous utilisez cette propriété, aucun élément du texte de l'événement lui-même n'est transmis à la cible.

Type : chaîne

Obligatoire : non

AWS CloudFormation compatibilité : cette propriété est transmise directement à la Input propriété d'une AWS::Events::Rule Target ressource.

InputPath

Lorsque vous ne voulez pas transmettre l'événement correspondant complet, utilisez la propriété InputPath pour décrire quelles parties de l'événement transmettre à la cible.

Type : chaîne

Obligatoire : non

AWS CloudFormation compatibilité : cette propriété est transmise directement à la InputPath propriété d'une AWS::Events::Rule Target ressource.

Pattern

Décrit les événements qui sont acheminés vers la cible spécifiée. Pour plus d'informations, consultez la section Événements et modèles d'événements EventBridge dans le guide de EventBridge l'utilisateur Amazon.

Type : EventPattern

Obligatoire : oui

AWS CloudFormation compatibilité : cette propriété est transmise directement à la EventPattern propriété d'une AWS::Events::Rule ressource.

State

État de la règle.

Valeurs acceptées : DISABLED | ENABLED

Note

Spécifiez la propriété Enabled ou la propriété State, mais pas les deux.

Type : chaîne

Obligatoire : non

AWS CloudFormation compatibilité : cette propriété est transmise directement à la State propriété d'une AWS::Events::Rule ressource.

Exemples

CloudWatchEvent

Voici un exemple de type de source d'événement CloudWatchEvent.

YAML

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