Schedule

L'oggetto che descrive un tipo di origineSchedule dell'evento, che imposta la funzione serverless come obiettivo di una EventBridge regola che viene attivata in base a una pianificazione. Per ulteriori informazioni, consulta consulta Che cos'è Amazon EventBridge? nella Guida per EventBridge l'utente di Amazon.

AWS Serverless Application Model(AWS SAM) genera una AWS::Events::Rulerisorsa quando questo tipo di evento è impostato.

Sintassi

Per dichiarare questa entità nel modelloAWS Serverless Application Model (AWS SAM), utilizzare la sintassi seguente.

YAML

  DeadLetterConfig: DeadLetterConfig
  Description: String
  Enabled: Boolean
  Input: String
  Name: String
  RetryPolicy: RetryPolicy
  Schedule: String
  State: String

Proprietà

DeadLetterConfig

Configura la coda Amazon Simple Queue Service (Amazon SQS) dove EventBridge invia gli eventi dopo una chiamata di destinazione non riuscita. La chiamata può fallire, ad esempio, quando si invia un evento a una funzione Lambda che non esiste o quando non EventBridge dispone di autorizzazioni sufficienti per richiamare la funzione Lambda. Per ulteriori informazioni, consulta Criterio tentativi di eventi e utilizzo di dead-letter queue, consulta Criterio tentativi di eventi e EventBridge utilizzo

Nota

Il tipo diAWS::Serverless::Function risorsa ha un tipo di dati simileDeadLetterQueue, che gestisce gli errori che si verificano dopo il corretto richiamo della funzione Lambda di destinazione. Esempi di questi tipi di errori includono la limitazione Lambda o gli errori restituiti dalla funzione di destinazione Lambda. Per ulteriori informazioni sullaDeadLetterQueue proprietà della funzione, vedete le code con lettere morte delleAWS Lambda funzioni nella Guida per gliAWS Lambda sviluppatori.

Tipo: DeadLetterConfig

Richiesto: No

AWS CloudFormationcompatibilità: Questa proprietà è simile allaDeadLetterConfig proprietà del tipo diAWS::Events::RuleTarget dati. LaAWS SAM versione di questa proprietà include sottoproprietà aggiuntive, nel caso in cui si desideriAWS SAM creare la coda di lettere morte per te.

Description

Descrizione della regola.

Type: Stringa

Richiesto: No

AWS CloudFormationcompatibilità: Questa proprietà viene passata direttamente allaDescription proprietà di unaAWS::Events::Rule risorsa.

Enabled

Indica se la regola è abilitata.

Per disattivare la regola, impostate questa proprietà sufalse.

Nota

Specificate laState proprietàEnabled or, ma non entrambe.

Type: Boolean

Richiesto: No

AWS CloudFormationcompatibilità: Questa proprietà è simile allaState proprietà di unaAWS::Events::Rule risorsa. Se questa proprietà è impostata sutrue alloraAWS SAM passaENABLED, altrimenti passaDISABLED.

Input

Testo JSON valido passato al target. Se utilizzi questa proprietà, al target non viene passata alcuna informazione sul testo dell'evento.

Type: Stringa

Richiesto: No

AWS CloudFormationcompatibilità: Questa proprietà viene passata direttamente allaInput proprietà di unaAWS::Events::Rule Target risorsa.

Name

Nome della regola . Se non specifichi un nome, AWS CloudFormation genera un ID fisico univoco e lo utilizza per il nome della regola.

Type: Stringa

Richiesto: No

AWS CloudFormationcompatibilità: Questa proprietà viene passata direttamente allaName proprietà di unaAWS::Events::Rule risorsa.

RetryPolicy

Un oggetto RetryPolicy che include informazioni sulle impostazioni dei criteri di nuovi tentativi. Per ulteriori informazioni, consulta Criterio tentativi di eventi e utilizzo di dead-letter queue, consulta Criterio tentativi di eventi e EventBridge utilizzo

Tipo: RetryPolicy

Richiesto: No

AWS CloudFormationcompatibilità: Questa proprietà viene passata direttamente allaRetryPolicy proprietà del tipo diAWS::Events::RuleTarget dati.

Schedule

L'espressione di programmazione che determina il momento e la frequenza di esecuzione della regola. Per ulteriori informazioni, consulta Pianificazione di espressioni per regole.

Type: Stringa

Richiesto: Sì

AWS CloudFormationcompatibilità: Questa proprietà viene passata direttamente allaScheduleExpression proprietà di unaAWS::Events::Rule risorsa.

State

Lo stato della regola.

Valori accettati:DISABLED | ENABLED

Nota

Specificate laState proprietàEnabled or, ma non entrambe.

Type: Stringa

Richiesto: No

AWS CloudFormationcompatibilità: Questa proprietà viene passata direttamente allaState proprietà di unaAWS::Events::Rule risorsa.

Examples (Esempi)

CloudWatch Pianifica evento

CloudWatch Esempi di eventi di pianificazione

YAML

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