CloudWatchEvent

El objeto que describe un tipo de fuente de evento CloudWatchEvent.

AWS Serverless Application Model (AWS SAM) genera un recurso AWS::Events::Rule cuando se establece este tipo de evento.

Nota importante: EventBridgeRule es el tipo de fuente de eventos de uso preferente, en lugar de CloudWatchEvent. EventBridgeRule y CloudWatchEvent usan el mismo servicio, API y recursos de AWS CloudFormation subyacentes. Sin embargo, solo AWS SAM añadirá compatibilidad para nuevas características solo a EventBridgeRule.

Sintaxis

Para declarar esta entidad en tu plantilla de AWS Serverless Application Model (AWS SAM), usa la siguiente sintaxis:

YAML

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

Propiedades

Enabled

Indica si la regla está habilitada.

Para deshabilitar la regla, defina esta propiedad en false.

nota

Especifica la propiedad Enabled o State, pero no ambas.

Tipo: Booleano

Obligatorio: no

Compatibilidad con AWS CloudFormation: esta propiedad es similar a la propiedad State de un recurso AWS::Events::Rule. Si esta propiedad se establece en true entonces AWS SAM pasa; de lo contrarioENABLED, pasa DISABLED.

EventBusName

El bus de eventos que se asociará a esta regla. Si omites esta propiedad, AWS SAM utilizará el bus de eventos predeterminado.

Tipo: cadena

Obligatorio: no

Predeterminado: bus de eventos predeterminado

Compatibilidad con AWS CloudFormation: esta propiedad se transfiere directamente a la propiedad EventBusName de un recurso AWS::Events::Rule.

Input

Texto JSON válido transmitido al destino. Si utiliza esta propiedad, no se transmitirá nada del propio texto del evento al destino.

Tipo: cadena

Obligatorio: no

Compatibilidad con AWS CloudFormation: esta propiedad se transfiere directamente a la propiedad Input de un recurso AWS::Events::Rule Target.

InputPath

Cuando no desee pasar todo el evento coincidente al destino, utilice la propiedad InputPath para describir qué parte del evento pasar.

Tipo: cadena

Obligatorio: no

Compatibilidad con AWS CloudFormation: esta propiedad se transfiere directamente a la propiedad InputPath de un recurso AWS::Events::Rule Target.

Pattern

Describe qué eventos se dirigen al destino especificado. Para obtener más información, consulta Eventos y patrones de eventos en EventBridge en la Guía del usuario de Amazon EventBridge.

Tipo: EventPattern

Obligatorio: sí

Compatibilidad con AWS CloudFormation: esta propiedad se transfiere directamente a la propiedad EventPattern de un recurso AWS::Events::Rule.

State

El estado de la regla.

Valores aceptados DISABLED | ENABLED:

nota

Especifica la propiedad Enabled o State, pero no ambas.

Tipo: cadena

Obligatorio: no

Compatibilidad con AWS CloudFormation: esta propiedad se transfiere directamente a la propiedad State de un recurso AWS::Events::Rule.

Ejemplos

CloudWatchEvent

A continuación, se muestra un ejemplo de un tipo de fuente de evento CloudWatchEvent.

YAML

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