ScheduleV2

L'oggetto che descrive un tipo di origine diScheduleV2 eventi, che imposta la tua macchina a stati come destinazione di un evento Amazon EventBridge Scheduler che si attiva in base a una pianificazione. Per ulteriori informazioni, consulta Che cos'è Amazon EventBridge Scheduler? nella Guida per l'utenteEventBridge di 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 modelloAWS Serverless Application Model (AWS SAM), utilizzare la sintassi seguente.

YAML

DeadLetterConfig: DeadLetterConfig
Description: String
EndDate: String
FlexibleTimeWindow: FlexibleTimeWindow
GroupName: String
Input: String
KmsKeyArn: String
Name: String
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) in cui EventBridge 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 non EventBridge dispone di autorizzazioni sufficienti per richiamare la funzione Lambda. Per ulteriori informazioni, vedere Configurazione di una coda di lettere scadute per EventBridge Scheduler nella Guida per l'utente diEventBridge Scheduler.

Tipo: DeadLetterConfig

Required: No

AWS CloudFormationcompatibilità: questa proprietà è simile allaDeadLetterConfig proprietà del tipo diAWS::Scheduler::ScheduleTarget dati. LaAWS SAM versione di questa proprietà include sottoproprietà aggiuntive, nel caso in cui si desideriAWS SAM creare automaticamente la coda delle lettere non valide.

Description

La descrizione della pianificazione.

Tipo: stringa

Required: No

AWS CloudFormationcompatibilità: questa proprietà viene passata direttamente allaDescription proprietà di unaAWS::Scheduler::Schedule risorsa.

EndDate

La data, in UTC, prima della quale la pianificazione può invocare il proprio obiettivo. A seconda dell'espressione di ricorrenza della pianificazione, le invocazioni potrebbero interrompersi in corrispondenza o prima di quanto specificato.EndDate

Tipo: stringa

Required: No

AWS CloudFormationcompatibilità: questa proprietà viene passata direttamente allaEndDate 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 allaFlexibleTimeWindow proprietà di unaAWS::Scheduler::Schedule risorsa.

GroupName

Il nome del gruppo di programmazione da associare a questa pianificazione. Se non è definito, viene utilizzato il gruppo predefinito.

Tipo: stringa

Required: No

AWS CloudFormationcompatibilità: questa proprietà viene passata direttamente allaGroupName 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 allaInput proprietà di unaAWS::Scheduler::Schedule Target risorsa.

KmsKeyArn

L'ARN di una chiave KMS che verrà utilizzata per crittografare i dati del cliente.

Tipo: stringa

Required: No

AWS CloudFormationcompatibilità: questa proprietà viene passata direttamente allaKmsKeyArn proprietà di unaAWS::Scheduler::Schedule risorsa.

Name

Il nome della pianificazione. Se non specifichi un nome,AWS SAM lo genera nel formatoStateMachine-Logical-IDEvent-Source-Name e lo utilizza per il nome della pianificazione.

Tipo: stringa

Required: No

AWS CloudFormationcompatibilità: questa proprietà viene passata direttamente allaName proprietà di unaAWS::Scheduler::Schedule risorsa.

PermissionsBoundary

L'ARN della policy utilizzata per impostare il limite delle autorizzazioni per il ruolo.

Nota

SePermissionsBoundary è 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 allaPermissionsBoundary 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 allaRetryPolicy proprietà del tipo diAWS::Scheduler::ScheduleTarget dati.

RoleArn

L'ARN del ruolo IAM che EventBridge Scheduler utilizzerà per il target quando la pianificazione viene richiamata.

Tipo: RoleArn

Required: No

AWS CloudFormationcompatibilità: questa proprietà viene passata direttamente allaRoleArn proprietà del tipo diAWS::Scheduler::ScheduleTarget dati.

ScheduleExpression

L'espressione di programmazione che determina il momento e la frequenza di esecuzione della pianificazione.

Tipo: stringa

Required: Yes

AWS CloudFormationcompatibilità: questa proprietà viene passata direttamente allaScheduleExpression 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 allaScheduleExpressionTimezone proprietà di unaAWS::Scheduler::Schedule risorsa.

StartDate

La data, in UTC, dopo la quale la pianificazione può iniziare a invocare un obiettivo. A seconda dell'espressione di ricorrenza della pianificazione, le invocazioni potrebbero avvenire il giorno o dopoStartDate quello specificato.

Tipo: stringa

Required: No

AWS CloudFormationcompatibilità: questa proprietà viene passata direttamente allaStartDate proprietà di unaAWS::Scheduler::Schedule risorsa.

State

Lo stato della pianificazione.

Valori accettati:DISABLED | ENABLED

Tipo: stringa

Required: No

AWS CloudFormationcompatibilità: questa proprietà viene passata direttamente allaState proprietà di unaAWS::Scheduler::Schedule risorsa.

Esempi

Esempio di base di definizione di una risorsa ScheduleV2

StateMachine:
  Type: AWS::Serverless::StateMachine
  Properties:
    Name: MyStateMachine
    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
    DefinitionUri:
      Bucket: sam-demo-bucket
      Key: my-state-machine.asl.json
      Version: 3
    Policies:
      - LambdaInvokePolicy:
          FunctionName: !Ref MyFunction