CloudWatchEvent

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

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

Nota importante: EventBridgeRule es el tipo de fuente de eventos preferido para usar, en lugar deCloudWatchEvent. EventBridgeRuley CloudWatchEvent usa el mismo servicio, API y AWS CloudFormation recursos subyacentes. Sin embargo, solo AWS SAM agregará soporte para nuevas funciones paraEventBridgeRule.

Sintaxis

Para declarar esta entidad en tu plantilla 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

Especifique la propiedad Enabled o State, pero no ambas.

Tipo: Booleano

Obligatorio: no

AWS CloudFormation compatibilidad: esta propiedad es similar a la State propiedad de un AWS::Events::Rule recurso. Si esta propiedad se establece en, true entonces, se AWS SAM aprueba; de lo contrarioENABLED, se apruebaDISABLED.

EventBusName

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

Tipo: cadena

Obligatorio: no

Predeterminado: bus de eventos predeterminado

AWS CloudFormation compatibilidad: esta propiedad se pasa directamente a la EventBusName propiedad de un AWS::Events::Rule recurso.

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

AWS CloudFormation compatibilidad: esta propiedad se pasa directamente a la Input propiedad de un AWS::Events::Rule Target recurso.

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

AWS CloudFormation compatibilidad: esta propiedad se pasa directamente a la InputPath propiedad de un AWS::Events::Rule Target recurso.

Pattern

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

Tipo: EventPattern

Obligatorio: sí

AWS CloudFormation compatibilidad: esta propiedad se pasa directamente a la EventPattern propiedad de un AWS::Events::Rule recurso.

State

El estado de la regla.

Valores aceptados DISABLED | ENABLED:

nota

Especifique la propiedad Enabled o State, pero no ambas.

Tipo: cadena

Obligatorio: no

AWS CloudFormation compatibilidad: esta propiedad se pasa directamente a la State propiedad de un AWS::Events::Rule recurso.

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