CloudWatchEvent - AWS Serverless Application Model
SintaxePropriedadesExemplos

CloudWatchEvent

O objeto que descreve um tipo de fonte de evento CloudWatchEvent.

AWS Serverless Application Model (AWS SAM) gera um recurso AWS::Events::Rule quando esse tipo de evento é definido.

Observação importante: EventBridgeRule é o tipo de origem de eventos preferido a ser usado, em vez de CloudWatchEvent. O EventBridgeRule e o CloudWatchEvent usam o mesmo serviço, API e recursos subjacentes CloudFormation. No entanto, o AWS SAM adicionará suporte para novos recursos somente para EventBridgeRule.

Sintaxe

Para declarar esta entidade no modelo do AWS Serverless Application Model (AWS SAM), use a seguinte sintaxe:

YAML

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

Propriedades

Enabled

Indica se a regra está habilitada.

Para desativar a regra, defina essa propriedade como false.

nota

Especifique a propriedade Enabled ou State, mas não ambas.

Tipo: booliano

Obrigatório: não

Compatibilidade CloudFormation: essa propriedade é semelhante à propriedade State de um recurso AWS::Events::Rule. Se essa propriedade for definida como true então AWS SAM passa a ENABLED, caso contrário, ela passa a DISABLED.

EventBusName

O barramento de eventos que deve ser associado a essa regra. Se você omitir essa propriedade, o AWS SAM usará o barramento de eventos padrão.

Tipo: string

Obrigatório: não

Padrão: barramento de eventos padrão

Compatibilidade CloudFormation: essa propriedade é passada diretamente para a propriedade EventBusName de um recurso AWS::Events::Rule.

Input

Texto JSON válido passado para o destino. Se você usar essa propriedade, nada do próprio texto do evento é passado para o destino.

Tipo: string

Obrigatório: não

Compatibilidade CloudFormation: essa propriedade é passada diretamente para a propriedade Input de um recurso AWS::Events::Rule Target.

InputPath

Quando você não deseja passar todo o evento correspondente ao destino, a propriedade InputPath descreve qual parte do evento passar.

Tipo: string

Obrigatório: não

Compatibilidade CloudFormation: essa propriedade é passada diretamente para a propriedade InputPath de um recurso AWS::Events::Rule Target.

Pattern

Descreve quais eventos são roteados para o destino especificado. Para obter mais informações, consulte Eventos e padrões de eventos no EventBridge no Guia do usuário do Amazon EventBridge.

Tipo: EventPattern

Obrigatório: Sim

Compatibilidade CloudFormation: essa propriedade é passada diretamente para a propriedade EventPattern de um recurso AWS::Events::Rule.

State

O estado da regra.

Valores aceitos: DISABLED | ENABLED

nota

Especifique a propriedade Enabled ou State, mas não ambas.

Tipo: string

Obrigatório: não

Compatibilidade CloudFormation: essa propriedade é passada diretamente para a propriedade State de um recurso AWS::Events::Rule.

Exemplos

CloudWatchEvent

O exemplo a seguir mostra o tipo de origem de um evento CloudWatchEvent.

YAML

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