Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

# Schedule
<a name="sam-property-statemachine-statemachineschedule"></a>

El objeto que describe un tipo de fuente de `Schedule` eventos, que establece su máquina de estados como el objetivo de una EventBridge regla que se activa según una programación. Para obtener más información, consulta [¿Qué es Amazon EventBridge?](https://docs.aws.amazon.com/eventbridge/latest/userguide/what-is-amazon-eventbridge.html) en la *Guía del EventBridge usuario de Amazon*.

AWS Serverless Application Model (AWS SAM) genera un [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 cuando se establece este tipo de evento.

## Sintaxis
<a name="sam-property-statemachine-statemachineschedule-syntax"></a>

Para declarar esta entidad en tu plantilla AWS Serverless Application Model (AWS SAM), usa la siguiente sintaxis.

### YAML
<a name="sam-property-statemachine-statemachineschedule-syntax.yaml"></a>

```
  [DeadLetterConfig](#sam-statemachine-statemachineschedule-deadletterconfig): {{DeadLetterConfig}}
  [Description](#sam-statemachine-statemachineschedule-description): {{String}}
  [Enabled](#sam-statemachine-statemachineschedule-enabled): {{Boolean}}
  [Input](#sam-statemachine-statemachineschedule-input): {{String}}
  [Name](#sam-statemachine-statemachineschedule-name): {{String}}
  [RetryPolicy](#sam-statemachine-statemachineschedule-retrypolicy): {{[RetryPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-retrypolicy)}}
  [RoleArn](#sam-statemachine-statemachineschedulev-rolearn): {{String}}
  [Schedule](#sam-statemachine-statemachineschedule-schedule): {{String}}
  [State](#sam-statemachine-statemachineschedule-state): {{String}}
  Target: {{Target}}
```

## Propiedades
<a name="sam-property-statemachine-statemachineschedule-properties"></a>

 `DeadLetterConfig`   <a name="sam-statemachine-statemachineschedule-deadletterconfig"></a>
Configure la cola del Amazon Simple Queue Service (Amazon SQS), desde la que EventBridge se envían los eventos tras una invocación de destino fallida. La invocación puede fallar, por ejemplo, cuando se envía un evento a una función de Lambda que no existe o EventBridge cuando no hay permisos suficientes para invocar la función de Lambda. *Para obtener más información, consulta la [política de reintentos de eventos y el uso de colas con letra muerta en la Guía del usuario](https://docs.aws.amazon.com/eventbridge/latest/userguide/rule-dlq.html) de Amazon. EventBridge *  
*Tipo:* [DeadLetterConfig](sam-property-statemachine-statemachinescheduledeadletterconfig.md)  
*Obligatorio*: no  
*CloudFormation compatibilidad*: esta propiedad es similar a la `[DeadLetterConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-deadletterconfig)` propiedad del tipo de datos. `AWS::Events::Rule` `Target` La AWS SAM versión de esta propiedad incluye subpropiedades adicionales, por si AWS SAM quiere crear automáticamente una cola de texto sin procesar.

 `Description`   <a name="sam-statemachine-statemachineschedule-description"></a>
Una descripción del conjunto de reglas.  
*Tipo*: cadena  
*Obligatorio*: no  
*CloudFormation compatibilidad*: esta propiedad se transfiere directamente a la `[Description](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-description)` propiedad de un recurso. `AWS::Events::Rule`

 `Enabled`   <a name="sam-statemachine-statemachineschedule-enabled"></a>
Indica si la regla está habilitada.  
Para deshabilitar la regla, defina esta propiedad en `false`.  
Especifique la propiedad `Enabled` o `State`, pero no ambas.
*Tipo*: Booleano  
*Obligatorio*: no  
*CloudFormation compatibilidad*: esta propiedad es similar a la `[State](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-state)` propiedad de un `AWS::Events::Rule` recurso. Si esta propiedad se establece en, `true` entonces, se AWS SAM aprueba; de lo contrario`ENABLED`, se aprueba`DISABLED`.

 `Input`   <a name="sam-statemachine-statemachineschedule-input"></a>
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  
*CloudFormation compatibilidad*: esta propiedad se pasa directamente a la `[Input](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-input)` propiedad de un `AWS::Events::Rule Target` recurso.

 `Name`   <a name="sam-statemachine-statemachineschedule-name"></a>
El nombre de la regla. Si no especificas un nombre, CloudFormation genera un identificador físico único y lo utiliza como nombre de la regla.  
*Tipo:* cadena  
*Obligatorio*: no  
*CloudFormation compatibilidad*: esta propiedad se transfiere directamente a la `[Name](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-name)` propiedad de un `AWS::Events::Rule` recurso.

 `RetryPolicy`   <a name="sam-statemachine-statemachineschedule-retrypolicy"></a>
Objeto de la `RetryPolicy` que incluye información acerca de la configuración de la política de reintentos. *Para obtener más información, consulta la [política de reintentos de eventos y el uso de colas con letra muerta en la Guía del usuario](https://docs.aws.amazon.com/eventbridge/latest/userguide/rule-dlq.html) de Amazon. EventBridge *  
*Tipo:* [RetryPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-retrypolicy)  
*Obligatorio*: no  
*CloudFormation compatibilidad*: esta propiedad se transfiere directamente a la `[RetryPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-target.html#cfn-events-rule-target-retrypolicy)` propiedad del tipo de datos. `AWS::Events::Rule` `Target`

 `RoleArn`   <a name="sam-statemachine-statemachineschedulev-rolearn"></a>
El ARN de la función de IAM que EventBridge Scheduler utilizará para el destino cuando se invoque la programación.  
*Tipo:* [RoleArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-target.html#cfn-scheduler-schedule-target-rolearn)  
*Requerido*: no. Si no se proporciona, se creará y utilizará un nuevo rol.  
*CloudFormation compatibilidad*: esta propiedad se transfiere directamente a la `[RoleArn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-target.html#cfn-scheduler-schedule-target-rolearn)` propiedad del tipo de `AWS::Scheduler::Schedule` `Target` datos.

 `Schedule`   <a name="sam-statemachine-statemachineschedule-schedule"></a>
La expresión de programación que determina cuándo y con qué frecuencia se ejecuta la regla. Para obtener más información, consulta [Expresiones de programación para reglas](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-create-rule-schedule.html).  
*Tipo*: cadena  
*Obligatorio*: sí  
*CloudFormation compatibilidad*: esta propiedad se pasa directamente a la `[ScheduleExpression](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-scheduleexpression)` propiedad de un `AWS::Events::Rule` recurso.

 `State`   <a name="sam-statemachine-statemachineschedule-state"></a>
El estado de la regla.  
*Valores aceptados* `DISABLED | ENABLED`:  
Especifique la propiedad `Enabled` o `State`, pero no ambas.
*Tipo*: cadena  
*Obligatorio*: no  
*CloudFormation compatibilidad*: esta propiedad se pasa directamente a la `[State](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-state)` propiedad de un `AWS::Events::Rule` recurso.

 `Target`   <a name="sam-statemachine-statemachineschedule-target"></a>
El AWS recurso que se EventBridge invoca cuando se activa una regla. Puedes utilizar esta propiedad para especificar el ID lógico del objetivo. Si no se especifica esta propiedad, AWS SAM genera el ID lógico del objetivo.  
*Tipo*: [destino](sam-property-statemachine-statemachinetarget.md)  
*Obligatorio*: no  
*CloudFormation compatibilidad*: esta propiedad es similar a la `[Targets](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html#cfn-events-rule-targets)` propiedad de un `AWS::Events::Rule` recurso. La AWS SAM versión de esta propiedad solo permite especificar el identificador lógico de un único destino.

## Ejemplos
<a name="sam-property-statemachine-statemachineschedule--examples"></a>

### CloudWatch Programe un evento
<a name="sam-property-statemachine-statemachineschedule--examples--cloudwatch-schedule-event"></a>

CloudWatch Ejemplo de programar un evento

#### YAML
<a name="sam-property-statemachine-statemachineschedule--examples--cloudwatch-schedule-event--yaml"></a>

```
CWSchedule:
  Type: Schedule
  Properties:
    Schedule: 'rate(1 minute)'
    Name: TestSchedule
    Description: test schedule
    Enabled: false
```