CloudWatchEvent

El objeto que describe un tipo de fuente deCloudWatchEvent eventos.

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. EventBridgeRuleyCloudWatchEvent utilice el mismo servicio, API yAWS CloudFormation recursos subyacentes. Sin embargo, soloAWS SAM agregará soporte para nuevas funciones aEventBridgeRule.

Sintaxis

Para declarar esta entidad en su plantillaAWS Serverless Application Model (AWS SAM), use 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 enfalse.

nota

Especifique laState propiedadEnabled o, pero no ambas.

Type: Booleano

Necesario: No

AWS CloudFormationcompatibilidad: Esta propiedad es similar a laState propiedad de unAWS::Events::Rule recurso. Si esta propiedad se establece entrue entoncesAWS SAM pasaENABLED, de lo contrario pasaDISABLED.

EventBusName

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

Type: Cadena

Necesario: No

Valor predeterminado: Bus de eventos predeterminado

AWS CloudFormationcompatibilidad: Esta propiedad se pasa directamente a laEventBusName propiedad de unAWS::Events::Rule recurso.

Input

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

Type: Cadena

Necesario: No

AWS CloudFormationcompatibilidad: Esta propiedad se pasa directamente a laInput propiedad de unAWS::Events::Rule Target recurso.

InputPath

Si no desea transferir todo el evento asociado al destino, use laInputPath propiedad para describir qué parte del evento debe transferirse.

Type: Cadena

Necesario: No

AWS CloudFormationcompatibilidad: Esta propiedad se pasa directamente a laInputPath propiedad de unAWS::Events::Rule Target recurso.

Pattern

Describe qué eventos se direccionan 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

Necesario: Sí

AWS CloudFormationcompatibilidad: Esta propiedad se pasa directamente a laEventPattern propiedad de unAWS::Events::Rule recurso.

State

El estado de la regla.

Valores aceptados:DISABLED | ENABLED

nota

Especifique laState propiedadEnabled o, pero no ambas.

Type: Cadena

Necesario: No

AWS CloudFormationcompatibilidad: Esta propiedad se pasa directamente a laState propiedad de unAWS::Events::Rule recurso.

Ejemplos

CloudWatchEvent

A continuación se muestra un ejemplo de un tipo de fuente deCloudWatchEvent eventos.

YAML

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