Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.
ScheduleV2
L'oggetto che descrive un tipo di origine ScheduleV2
dell'evento, che imposta la funzione serverless come destinazione di un evento Amazon EventBridge Scheduler che si attiva in base a una pianificazione. Per ulteriori informazioni, consulta Cos'è Amazon EventBridge Scheduler? nella Guida per l'utente di EventBridge Scheduler.
AWS Serverless Application Model(AWS SAM) genera una AWS::Scheduler::Schedulerisorsa quando viene impostato questo tipo di evento.
Sintassi
Per dichiarare questa entità nel tuo modello AWS Serverless Application Model (AWS SAM), usa la seguente sintassi.
YAML
DeadLetterConfig:
DeadLetterConfig
Description:String
EndDate:String
FlexibleTimeWindow:FlexibleTimeWindow
GroupName:String
Input:String
KmsKeyArn:String
Name:String
OmitName:Boolean
PermissionsBoundary:String
RetryPolicy:RetryPolicy
RoleArn:String
ScheduleExpression:String
ScheduleExpressionTimezone:String
StartDate: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 Configurazione di una coda di lettere non scritte per Scheduler nella Scheduler User Guide. EventBridge EventBridge
Nota
Il tipo di AWS::Serverless::Function risorsa ha un tipo di dati simile
DeadLetterQueue
, 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 sullaDeadLetterQueue
proprietà della funzione, consulta Dead-letter queues nella Developer Guide. AWS LambdaTipo: DeadLetterConfig
Required: No
AWS CloudFormationcompatibilità: questa proprietà è simile alla
DeadLetterConfig
proprietà del tipo diAWS::Scheduler::Schedule
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 morte. -
Description
-
Una descrizione della pianificazione.
Tipo: stringa
Required: No
AWS CloudFormationcompatibilità: questa proprietà viene passata direttamente alla
Description
proprietà di unaAWS::Scheduler::Schedule
risorsa. -
EndDate
-
La data, in UTC, prima della quale la pianificazione può richiamare il suo obiettivo. A seconda dell'espressione di ricorrenza della pianificazione, le chiamate potrebbero interrompersi nel momento in cui specifichi EndDate o prima.
Tipo: stringa
Required: No
AWS CloudFormationcompatibilità: questa proprietà viene passata direttamente alla
EndDate
proprietà di unaAWS::Scheduler::Schedule
risorsa. -
FlexibleTimeWindow
-
Consente la configurazione di una finestra all'interno della quale è possibile richiamare una pianificazione.
Tipo: FlexibleTimeWindow
Required: No
AWS CloudFormationcompatibilità: questa proprietà viene passata direttamente alla
FlexibleTimeWindow
proprietà di unaAWS::Scheduler::Schedule
risorsa. -
GroupName
-
Il nome del gruppo di pianificazione da associare a questa pianificazione. Se non è definito, viene utilizzato il gruppo predefinito.
Tipo: stringa
Required: No
AWS CloudFormationcompatibilità: questa proprietà viene passata direttamente alla
GroupName
proprietà di unaAWS::Scheduler::Schedule
risorsa. -
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 unaAWS::Scheduler::Schedule Target
risorsa. -
KmsKeyArn
-
L'ARN per una chiave KMS che verrà utilizzata per crittografare i dati dei clienti.
Tipo: stringa
Required: No
AWS CloudFormationcompatibilità: questa proprietà viene passata direttamente alla
KmsKeyArn
proprietà di una risorsa.AWS::Scheduler::Schedule
-
Name
-
Il nome della pianificazione. Se non specifichi un nome, AWS SAM genera un nome nel formato
e utilizza quell'ID per il nome della pianificazione.Function-Logical-ID
Event-Source-Name
Tipo: stringa
Required: No
AWS CloudFormationcompatibilità: questa proprietà viene passata direttamente alla
Name
proprietà di unaAWS::Scheduler::Schedule
risorsa. OmitName
-
Per impostazione predefinita, AWS SAM genera e utilizza un nome di pianificazione nel formato
< event-source-name >
<Function-logical-ID>. Imposta questa proprietà intrue
modo da AWS CloudFormation generare un ID fisico univoco e utilizzalo invece per il nome della pianificazione.Tipo: Booleano
Required: No
Default:
false
AWS CloudFormationcompatibilità: questa proprietà è unica AWS SAM e non ha un AWS CloudFormation equivalente.
-
PermissionsBoundary
-
L'ARN della policy utilizzata per impostare il limite delle autorizzazioni per il ruolo.
Nota
Se
PermissionsBoundary
definito, AWS SAM applicherà gli stessi limiti al ruolo IAM di destinazione della pianificazione dello scheduler.Tipo: stringa
Required: No
AWS CloudFormationcompatibilità: questa proprietà viene passata direttamente alla
PermissionsBoundary
proprietà di unaAWS::IAM::Role
risorsa. -
RetryPolicy
-
Un oggetto RetryPolicy che include informazioni sulle impostazioni dei criteri di nuovi tentativi.
Tipo: RetryPolicy
Required: No
AWS CloudFormationcompatibilità: questa proprietà viene passata direttamente alla
RetryPolicy
proprietà del tipo diAWS::Scheduler::Schedule
Target
dati. -
RoleArn
-
L'ARN del ruolo IAM che EventBridge Scheduler utilizzerà per la destinazione quando viene richiamata la pianificazione.
Tipo: RoleArn
Required: No
AWS CloudFormationcompatibilità: questa proprietà viene passata direttamente alla
RoleArn
proprietà del tipo diAWS::Scheduler::Schedule
Target
dati. -
ScheduleExpression
-
L'espressione di pianificazione che determina quando e con quale frequenza viene eseguito l'evento di pianificazione dello scheduler.
Tipo: stringa
Campo obbligatorio: sì
AWS CloudFormationcompatibilità: questa proprietà viene passata direttamente alla
ScheduleExpression
proprietà di unaAWS::Scheduler::Schedule
risorsa. -
ScheduleExpressionTimezone
-
Il fuso orario in cui viene valutata l'espressione di pianificazione.
Tipo: stringa
Required: No
AWS CloudFormationcompatibilità: questa proprietà viene passata direttamente alla
ScheduleExpressionTimezone
proprietà di unaAWS::Scheduler::Schedule
risorsa. -
StartDate
-
La data, in UTC, dopo la quale la pianificazione può iniziare a richiamare un obiettivo. A seconda dell'espressione di ricorrenza della pianificazione, le chiamate potrebbero interrompersi nel momento in cui specifichi StartDate o dopo.
Tipo: stringa
Required: No
AWS CloudFormationcompatibilità: questa proprietà viene passata direttamente alla
StartDate
proprietà di unaAWS::Scheduler::Schedule
risorsa. -
State
-
Lo stato della pianificazione dello Scheduler.
Valori accettati:
DISABLED | ENABLED
Tipo: stringa
Required: No
AWS CloudFormationcompatibilità: questa proprietà viene passata direttamente alla
State
proprietà di unaAWS::Scheduler::Schedule
risorsa.
Esempi
Esempio di base di definizione di una risorsa ScheduleV2
Resources: Function: Properties: ... Events: ScheduleEvent: Type: ScheduleV2 Properties: ScheduleExpression: "rate(1 minute)" ComplexScheduleEvent: Type: ScheduleV2 Properties: ScheduleExpression: rate(1 minute) FlexibleTimeWindow: Mode: FLEXIBLE MaximumWindowInMinutes: 5 StartDate: '2022-12-28T12:00:00.000Z' EndDate: '2023-01-28T12:00:00.000Z' ScheduleExpressionTimezone: UTC RetryPolicy: MaximumRetryAttempts: 5 MaximumEventAgeInSeconds: 300 DeadLetterConfig: Type: SQS