As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

# CloudWatchEvent
<a name="sam-property-function-cloudwatchevent"></a>

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

AWS Serverless Application Model (AWS SAM) gera um [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html)recurso quando esse tipo de evento é definido.

**Nota importante**: [EventBridgeRule](sam-property-function-eventbridgerule.md) é o tipo de fonte de eventos preferido a ser usado, em vez de`CloudWatchEvent`. `EventBridgeRule`e `CloudWatchEvent` use o mesmo serviço, API e CloudFormation recursos subjacentes. No entanto, AWS SAM adicionará suporte para novos recursos somente para`EventBridgeRule`.

## Sintaxe
<a name="sam-property-function-cloudwatchevent-syntax"></a>

Para declarar essa entidade em seu modelo AWS Serverless Application Model (AWS SAM), use a sintaxe a seguir.

### YAML
<a name="sam-property-function-cloudwatchevent-syntax.yaml"></a>

```
  [Enabled](#sam-function-cloudwatchevent-enabled): Boolean
  [EventBusName](#sam-function-cloudwatchevent-eventbusname): String
  [Input](#sam-function-cloudwatchevent-input): String
  [InputPath](#sam-function-cloudwatchevent-inputpath): String
  [Pattern](#sam-function-cloudwatchevent-pattern): [EventPattern](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-eventpattern)
  [State](#sam-function-cloudwatchevent-state): String
```

## Propriedades
<a name="sam-property-function-cloudwatchevent-properties"></a>

 `Enabled`   <a name="sam-function-cloudwatchevent-enabled"></a>
Indica se a regra está habilitada.  
Para desativar a regra, defina essa propriedade como `false`.  
Especifique a propriedade `Enabled` ou `State`, mas não ambas.
*Tipo*: booliano  
*Obrigatório*: não  
*CloudFormation compatibilidade*: essa propriedade é semelhante à `[State](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-state)` propriedade de um `AWS::Events::Rule` recurso. Se essa propriedade for definida como `true` então AWS SAM passa`ENABLED`, caso contrário, ela passa`DISABLED`.

 `EventBusName`   <a name="sam-function-cloudwatchevent-eventbusname"></a>
O barramento de eventos que deve ser associado a essa regra. Se você omitir essa propriedade, AWS SAM usará o barramento de eventos padrão.  
*Tipo:* string  
*Obrigatório*: não  
*Padrão*: barramento de eventos padrão  
*CloudFormation compatibilidade*: essa propriedade é passada diretamente para a `[EventBusName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-eventbusname)` propriedade de um `AWS::Events::Rule` recurso.

 `Input`   <a name="sam-function-cloudwatchevent-input"></a>
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  
*CloudFormation compatibilidade*: essa propriedade é passada diretamente para a `[Input](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-input)` propriedade de um `AWS::Events::Rule Target` recurso.

 `InputPath`   <a name="sam-function-cloudwatchevent-inputpath"></a>
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  
*CloudFormation compatibilidade*: essa propriedade é passada diretamente para a `[InputPath](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-inputpath)` propriedade de um `AWS::Events::Rule Target` recurso.

 `Pattern`   <a name="sam-function-cloudwatchevent-pattern"></a>
Descreve quais eventos são roteados para o destino especificado. Para obter mais informações, consulte [Eventos e padrões de eventos EventBridge no](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) *Guia do EventBridge usuário da Amazon*.  
*Digite*: [EventPattern](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-eventpattern)  
*Obrigatório*: Sim  
*CloudFormation compatibilidade*: essa propriedade é passada diretamente para a `[EventPattern](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-eventpattern)` propriedade de um `AWS::Events::Rule` recurso.

 `State`   <a name="sam-function-cloudwatchevent-state"></a>
O estado da regra.  
*Valores aceitos:* `DISABLED | ENABLED`  
Especifique a propriedade `Enabled` ou `State`, mas não ambas.
*Tipo:* string  
*Obrigatório*: não  
*CloudFormation compatibilidade*: essa propriedade é passada diretamente para a `[State](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-state)` propriedade de um `AWS::Events::Rule` recurso.

## Exemplos
<a name="sam-property-function-cloudwatchevent--examples"></a>

### CloudWatchEvent
<a name="sam-property-function-cloudwatchevent--examples--cloudwatchevent"></a>

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

#### YAML
<a name="sam-property-function-cloudwatchevent--examples--cloudwatchevent--yaml"></a>

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