Schedule

L'oggetto che descrive un tipo di origine Schedule degli eventi, che imposta la funzione serverless come destinazione di una EventBridge regola Amazon che si attiva in base a una pianificazione. Per ulteriori informazioni, consulta What Is Amazon EventBridge? nella Amazon EventBridge User Guide.

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

Nota

EventBridge ora offre una nuova funzionalità di pianificazione, Amazon EventBridge Scheduler. Amazon EventBridge Scheduler è uno strumento di pianificazione senza server che ti consente di creare, eseguire e gestire attività da un unico servizio gestito centralizzato. EventBridge Schedulerè altamente personalizzabile e offre una migliore scalabilità rispetto alle regole EventBridge pianificate, con un set più ampio di operazioni API mirate e. Servizi AWS

Si consiglia di EventBridge Scheduler utilizzarlo per richiamare gli obiettivi in base a una pianificazione. Per definire questo tipo di origine degli eventi nei tuoi AWS SAM modelli, consultaScheduleV2.

Sintassi

Per dichiarare questa entità nel tuo modello AWS Serverless Application Model (AWS SAM), usa la seguente sintassi.

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) a EventBridge cui invia gli eventi dopo una chiamata di destinazione non riuscita. L'invocazione può fallire, ad esempio, quando si invia un evento a una funzione Lambda che non esiste o quando EventBridge le autorizzazioni sono insufficienti per richiamare la funzione Lambda. Per ulteriori informazioni, consulta la politica di riprova degli eventi e l'utilizzo delle code di lettere morte nella Amazon User Guide. EventBridge

Nota

Il tipo di AWS::Serverless::Function risorsa ha un tipo di dati simileDeadLetterQueue, che gestisce gli errori che si verificano dopo una chiamata riuscita 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 sulla DeadLetterQueue proprietà della funzione, consulta Dead-letter queues nella Developer Guide. AWS Lambda

Tipo: DeadLetterConfig

Required: No

AWS CloudFormationcompatibilità: questa proprietà è simile alla DeadLetterConfig proprietà del tipo di AWS::Events::Rule Target dati. La AWS SAM versione di questa proprietà include sottoproprietà aggiuntive, nel caso in cui si desideri AWS SAM creare automaticamente la coda di lettere non scritte.

Description

Una descrizione della regola.

Tipo: stringa

Required: No

AWS CloudFormationcompatibilità: questa proprietà viene passata direttamente alla Description proprietà di una AWS::Events::Rule risorsa.

Enabled

Indica se la regola è abilitata.

Per disabilitare la regola, imposta questa proprietà sufalse.

Nota

Specificate la State proprietà Enabled o, ma non entrambe.

Tipo: Booleano

Required: No

AWS CloudFormationcompatibilità: questa proprietà è simile alla State proprietà di una AWS::Events::Rule risorsa. Se questa proprietà è impostata su true allora AWS 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.

Tipo: stringa

Required: No

AWS CloudFormationcompatibilità: questa proprietà viene passata direttamente alla Input proprietà di una AWS::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.

Tipo: stringa

Required: No

AWS CloudFormationcompatibilità: questa proprietà viene passata direttamente alla Name proprietà di una AWS::Events::Rule risorsa.

RetryPolicy

Un oggetto RetryPolicy che include informazioni sulle impostazioni dei criteri di nuovi tentativi. Per ulteriori informazioni, consulta la politica di riprova degli eventi e l'utilizzo delle code di lettere morte nella Amazon User Guide. EventBridge

Tipo: RetryPolicy

Required: No

AWS CloudFormationcompatibilità: questa proprietà viene passata direttamente alla RetryPolicy proprietà del tipo di AWS::Events::Rule Target 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.

Tipo: stringa

Campo obbligatorio: sì

AWS CloudFormationcompatibilità: questa proprietà viene passata direttamente alla ScheduleExpression proprietà di una AWS::Events::Rule risorsa.

State

Lo stato della regola.

Valori accettati: DISABLED | ENABLED

Nota

Specificate la State proprietà Enabled o, ma non entrambe.

Tipo: stringa

Required: No

AWS CloudFormationcompatibilità: questa proprietà viene passata direttamente alla State proprietà di una AWS::Events::Rule risorsa.

Esempi

CloudWatch Pianifica evento

CloudWatch Esempio di evento di pianificazione

YAML

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