

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á.

# EventBridgeRule
<a name="sam-property-function-eventbridgerule"></a>

O objeto que descreve um tipo de fonte de `EventBridgeRule` evento, que define sua função sem servidor como o destino de uma regra da Amazon EventBridge . Para obter mais informações, consulte [O que é a Amazon EventBridge?](https://docs.aws.amazon.com/eventbridge/latest/userguide/what-is-amazon-eventbridge.html) no *Guia do EventBridge usuário da Amazon*.

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. AWS SAM também cria um `AWS::Lambda::Permission` recurso, que é necessário para que eles `EventBridgeRule` possam chamar o Lambda.

## Sintaxe
<a name="sam-property-function-eventbridgerule-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-eventbridgerule-syntax.yaml"></a>

```
  [DeadLetterConfig](#sam-function-eventbridgerule-deadletterconfig): DeadLetterConfig
  [EventBusName](#sam-function-eventbridgerule-eventbusname): String
  [Input](#sam-function-eventbridgerule-input): String
  [InputPath](#sam-function-eventbridgerule-inputpath): String
  InputTransformer: [InputTransformer](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-inputtransformer.html)
  [Pattern](#sam-function-eventbridgerule-pattern): [EventPattern](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-eventpattern)
  [RetryPolicy](#sam-function-eventbridgerule-retrypolicy): [RetryPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-retrypolicy)
  RuleName: String 
  State: String
  [Target](#sam-function-eventbridgerule-target): Target
```

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

 `DeadLetterConfig`   <a name="sam-function-eventbridgerule-deadletterconfig"></a>
Configure a fila do Amazon Simple Queue Service (Amazon SQS) para a EventBridge qual envia eventos após uma falha na invocação de destino. A invocação pode falhar, por exemplo, ao enviar um evento para uma função Lambda que não existe ou quando não há permissões suficientes para invocar EventBridge a função Lambda. *Para obter mais informações, consulte [Política de repetição de eventos e uso de filas de mensagens sem saída no Guia do usuário](https://docs.aws.amazon.com/eventbridge/latest/userguide/rule-dlq.html) da Amazon. EventBridge *  
O tipo de recurso [AWS::Serverless::Function](sam-resource-function.md) tem um tipo de dados semelhante, `DeadLetterQueue`, que lida com falhas que ocorrem após a invocação bem-sucedida da função do Lambda de destino. Exemplos desses tipos de falhas incluem controle de utilização do Lambda ou erros retornados pela função de destino do Lambda. Para obter mais informações sobre a propriedade `DeadLetterQueue` da função, consulte [Filas de mensagens não entregues](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#invocation-dlq) no *Guia do desenvolvedor do AWS Lambda *.
*Digite*: [DeadLetterConfig](sam-property-function-deadletterconfig.md)  
*Obrigatório*: não  
*CloudFormation compatibilidade*: essa propriedade é semelhante à `[DeadLetterConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-deadletterconfig)` propriedade do tipo de `AWS::Events::Rule` `Target` dados. A AWS SAM versão dessa propriedade inclui subpropriedades adicionais, caso você queira criar AWS SAM a fila de mensagens mortas para você.

 `EventBusName`   <a name="sam-function-eventbridgerule-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-eventbridgerule-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-eventbridgerule-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.

 `InputTransformer`   <a name="sam-function-eventbridgerule-inputtransformer"></a>
Configurações para permitir que você forneça entrada personalizada para um destino com base em determinados dados de evento. Você pode extrair um ou mais pares de valor-chave do evento e usar esses dados para enviar a entrada personalizada para o destino. Para obter mais informações, consulte [Transformação EventBridge de entrada](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-transform-target-input.html) da *Amazon no Guia EventBridge do usuário da Amazon*.   
*Digite*: [InputTransformer](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-inputtransformer)  
*Obrigatório*: não  
*CloudFormation compatibilidade*: essa propriedade é passada diretamente para a `[InputTransformer](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-inputtransformer.html)` propriedade de um tipo de `AWS::Events::Rule` `Target` dados.

 `Pattern`   <a name="sam-function-eventbridgerule-pattern"></a>
Descreve quais eventos são roteados para o destino especificado. Para obter mais informações, consulte [ EventBridgeEventos e [padrões de EventBridge eventos](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-patterns.html) da Amazon](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-events.html) no *Guia EventBridge do 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.

 `RetryPolicy`   <a name="sam-function-eventbridgerule-retrypolicy"></a>
Um objeto `RetryPolicy` que inclui informações sobre as configurações de política de repetição. *Para obter mais informações, consulte [Política de repetição de eventos e uso de filas de mensagens sem saída no Guia do usuário](https://docs.aws.amazon.com/eventbridge/latest/userguide/rule-dlq.html) da Amazon. EventBridge *  
*Digite*: [RetryPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-retrypolicy)  
*Obrigatório*: não  
*CloudFormation compatibilidade*: essa propriedade é passada diretamente para a `[RetryPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-retrypolicy)` propriedade do tipo de `AWS::Events::Rule` `Target` dados.

 `RuleName`   <a name="sam-function-eventbridgerule-rulename"></a>
O nome da regra.  
*Tipo:* string  
*Obrigatório*: não  
*CloudFormation compatibilidade*: essa propriedade é passada diretamente para a `[Name](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-name)` propriedade de um `AWS::Events::Rule` recurso.

 `State`   <a name="sam-function-eventbridgerule-state"></a>
O estado da regra.  
*Valores aceitos*: `DISABLED` \$1 `ENABLED` \$1 `ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS`  
*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.

 `Target`   <a name="sam-function-eventbridgerule-target"></a>
O AWS recurso que é EventBridge invocado quando uma regra é acionada. Você pode usar essa propriedade para especificar a ID lógica do destino. Se essa propriedade não for especificada, a ID lógica do destino será AWS SAM gerada.  
*Tipo*: [Target](sam-property-function-target.md)  
*Obrigatório*: não  
*CloudFormation compatibilidade*: essa propriedade é semelhante à `[Targets](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-targets)` propriedade de um `AWS::Events::Rule` recurso. `Amazon EC2 RebootInstances API call`é um exemplo de uma propriedade alvo. A versão AWS SAM dessa propriedade só permite que você especifique a ID lógica de um único destino.

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

### EventBridgeRule
<a name="sam-property-function-eventbridgerule--examples--eventbridgerule"></a>

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

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

```
EBRule:
  Type: EventBridgeRule
  Properties:
    Input: '{"Key": "Value"}'
    Pattern:
      detail:
        state:
          - terminated
    RetryPolicy:
      MaximumRetryAttempts: 5
      MaximumEventAgeInSeconds: 900
    DeadLetterConfig:
      Type: SQS
      QueueLogicalId: EBRuleDLQ
    Target:
      Id: MyTarget
```

# DeadLetterConfig
<a name="sam-property-function-deadletterconfig"></a>

O objeto usado para especificar a fila do Amazon Simple Queue Service (Amazon SQS) para a EventBridge qual envia eventos após uma falha na invocação de destino. A invocação pode falhar, por exemplo, ao enviar um evento para uma função do Lambda que não existe ou permissões insuficientes para invocar a função do Lambda. *Para obter mais informações, consulte [Política de repetição de eventos e uso de filas de mensagens sem saída no Guia do usuário](https://docs.aws.amazon.com/eventbridge/latest/userguide/rule-dlq.html) da Amazon. EventBridge *

**nota**  
O tipo de recurso [AWS::Serverless::Function](sam-resource-function.md) tem um tipo de dados semelhante, `DeadLetterQueue` que lida com falhas que ocorrem após a invocação bem-sucedida da função do Lambda de destino. Exemplos desse tipo de falha incluem controle de utilização do Lambda ou erros retornados pela função de destino do Lambda. Para obter mais informações sobre a propriedade `DeadLetterQueue` da função, consulte as [filas de mensagens não entregues](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#invocation-dlq) no *Guia do desenvolvedor do AWS Lambda *.

## Sintaxe
<a name="sam-property-function-deadletterconfig-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-deadletterconfig-syntax.yaml"></a>

```
  [Arn](#sam-function-deadletterconfig-arn): String
  [QueueLogicalId](#sam-function-deadletterconfig-queuelogicalid): String
  [Type](#sam-function-deadletterconfig-type): String
```

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

 `Arn`   <a name="sam-function-deadletterconfig-arn"></a>
O nome de recurso da Amazon (ARN) da fila Amazon SQS especificado como o destino para a fila de mensagens não entregues.  
Especifique a propriedade `Type` ou a propriedade `Arn`, mas não ambas.
*Tipo:* string  
*Obrigatório*: não  
*CloudFormation compatibilidade*: essa propriedade é passada diretamente para a `[Arn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-deadletterconfig.html#cfn-events-rule-deadletterconfig-arn)` propriedade do tipo de `AWS::Events::Rule` `DeadLetterConfig` dados.

 `QueueLogicalId`   <a name="sam-function-deadletterconfig-queuelogicalid"></a>
O nome personalizado da fila de letras mortas que AWS SAM cria se `Type` for especificado.  
Se a propriedade `Type` não estiver definida, essa propriedade será ignorada.
*Tipo:* string  
*Obrigatório*: não  
*CloudFormation compatibilidade*: essa propriedade é exclusiva AWS SAM e não tem CloudFormation equivalente.

 `Type`   <a name="sam-function-deadletterconfig-type"></a>
O tipo da fila. Quando essa propriedade é definida, cria AWS SAM automaticamente uma fila de mensagens mortas e anexa a [política baseada em recursos](https://docs.aws.amazon.com/eventbridge/latest/userguide/rule-dlq.html#dlq-perms) necessária para conceder permissão ao recurso de regra para enviar eventos para a fila.  
Especifique a propriedade `Type` ou a propriedade `Arn`, mas não ambas.
*Valores válidos*: `SQS`  
*Tipo:* string  
*Obrigatório*: não  
*CloudFormation compatibilidade*: essa propriedade é exclusiva AWS SAM e não tem CloudFormation equivalente.

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

### DeadLetterConfig
<a name="sam-property-function-deadletterconfig--examples--deadletterconfig"></a>

DeadLetterConfig

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

```
DeadLetterConfig:
  Type: SQS
  QueueLogicalId: MyDLQ
```

# Target
<a name="sam-property-function-target"></a>

Configura o AWS recurso que é EventBridge invocado quando uma regra é acionada.

## Sintaxe
<a name="sam-property-function-target-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-target-syntax.yaml"></a>

```
  [Id](#sam-function-target-id): String
```

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

 `Id`   <a name="sam-function-target-id"></a>
O ID lógico do destino.  
O valor do `Id` pode incluir caracteres alfanuméricos, pontos (`.`), hifens (`-`) e sublinhados (`_`).  
*Tipo:* string  
*Obrigatório*: Sim  
*CloudFormation compatibilidade*: essa propriedade é passada diretamente para a `[Id](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-id)` propriedade do tipo de `AWS::Events::Rule` `Target` dados.

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

### Target
<a name="sam-property-function-target--examples--target"></a>

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

```
EBRule:
  Type: EventBridgeRule
  Properties:
    Target:
      Id: MyTarget
```