ScheduleV2

Das Objekt, das einen ScheduleV2 Ereignisquellentyp beschreibt, der Ihren Zustandsmaschine als Ziel eines Amazon EventBridge Scheduler-Ereignisses festlegt, das nach einem Zeitplan ausgelöst wird. Weitere Informationen finden Sie unter Was ist Amazon EventBridge Scheduler? im EventBridge Scheduler-Benutzerhandbuch.

AWS Serverless Application Model (AWS SAM) generiert eine AWS::Scheduler::ScheduleRessource, wenn dieser Ereignistyp festgelegt ist.

Syntax

Verwenden Sie die folgende Syntax, um diese Entität in Ihrer Vorlage AWS Serverless Application Model (AWS SAM) zu deklarieren.

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

Eigenschaften

DeadLetterConfig

Konfigurieren Sie die Amazon Simple Queue Service (Amazon SQS) -Warteschlange, über die Ereignisse nach einem fehlgeschlagenen Zielaufruf EventBridge gesendet werden. Der Aufruf kann beispielsweise fehlschlagen, wenn ein Ereignis an eine Lambda-Funktion gesendet wird, die nicht existiert, oder wenn EventBridge die Berechtigungen zum Aufrufen der Lambda-Funktion nicht ausreichen. Weitere Informationen finden Sie im Scheduler-Benutzerhandbuch unter Konfiguration einer Warteschlange mit uneingeschränkten Briefen für den EventBridge Scheduler. EventBridge

Typ: DeadLetterConfig

Required: No

AWS CloudFormation Kompatibilität: Diese Eigenschaft ähnelt der DeadLetterConfig Eigenschaft des AWS::Scheduler::Schedule Target Datentyps. Die AWS SAM Version dieser Eigenschaft enthält zusätzliche Untereigenschaften für den Fall, dass Sie die Warteschlange AWS SAM für unzustellbare Briefe erstellen möchten.

Description

Eine Beschreibung des Zeitplans.

Typ: Zeichenfolge

Required: No

AWS CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an die Description Eigenschaft einer AWS::Scheduler::Schedule Ressource übergeben.

EndDate

Das Datum in UTC, bevor der Zeitplan sein Ziel aufrufen kann. Abhängig vom Wiederholungsausdruck des Zeitplans können Aufrufe an oder vor dem von Ihnen angegebenen EndDate anhalten.

Typ: Zeichenfolge

Required: No

AWS CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an die EndDate Eigenschaft einer AWS::Scheduler::Schedule Ressource übergeben.

FlexibleTimeWindow

Ermöglicht die Konfiguration eines Fensters, in dem ein Zeitplan aufgerufen werden kann.

Typ: FlexibleTimeWindow

Required: No

AWS CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an die FlexibleTimeWindow Eigenschaft einer AWS::Scheduler::Schedule Ressource übergeben.

GroupName

Der Name der Zeitplangruppe, die diesem Zeitplan zugeordnet werden soll. Wenn nicht definiert, wird die Standardgruppe verwendet.

Typ: Zeichenfolge

Required: No

AWS CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an die GroupName Eigenschaft einer AWS::Scheduler::Schedule Ressource übergeben.

Input

Gültiger JSON-Text wurde an das Ziel übergeben. Wenn Sie diese Eigenschaft verwenden, wird nichts aus dem Ereignistext selbst an das Ziel weitergeleitet.

Typ: Zeichenfolge

Required: No

AWS CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an die Input Eigenschaft einer AWS::Scheduler::Schedule Target Ressource übergeben.

KmsKeyArn

Der ARN für einen KMS-Schlüssel, der zur Verschlüsselung von Kundendaten verwendet wird.

Typ: Zeichenfolge

Required: No

AWS CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an die KmsKeyArn Eigenschaft einer AWS::Scheduler::Schedule Ressource übergeben.

Name

Der Name des Plans. Wenn Sie keinen Namen angeben, AWS SAM generiert es einen Namen im Format StateMachine-Logical-IDEvent-Source-Name und verwendet diese ID als Namen des Zeitplans.

Typ: Zeichenfolge

Required: No

AWS CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an die Name Eigenschaft einer AWS::Scheduler::Schedule Ressource übergeben.

OmitName

AWS SAM Generiert und verwendet standardmäßig einen Zeitplannamen im Format <S tate-machine-logical event-source-name -ID>< >. Stellen Sie diese Eigenschaft auf ein, true um eine eindeutige physische ID zu AWS CloudFormation generieren und diese stattdessen für den Zeitplannamen zu verwenden.

Typ: Boolesch

Required: No

Standardwert: false

AWS CloudFormation Kompatibilität: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein AWS CloudFormation Äquivalent.

PermissionsBoundary

Der ARN der Richtlinie, mit der die Berechtigungsgrenze für die Rolle festgelegt wurde.

Anmerkung

Wenn sie definiert PermissionsBoundary ist, AWS SAM werden dieselben Grenzen auf die IAM-Zielrolle des Scheduler-Zeitplans angewendet.

Typ: Zeichenfolge

Required: No

AWS CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an die PermissionsBoundary Eigenschaft einer AWS::IAM::Role Ressource übergeben.

RetryPolicy

Ein RetryPolicy-Objekt, das Informationen zu den Richtlinieneinstellungen für Wiederholungsversuche enthält.

Typ: RetryPolicy

Required: No

AWS CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an die RetryPolicy Eigenschaft des AWS::Scheduler::Schedule Target Datentyps übergeben.

RoleArn

Der ARN der IAM-Rolle, die der EventBridge Scheduler für das Ziel verwendet, wenn der Zeitplan aufgerufen wird.

Typ: RoleArn

Required: No

AWS CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an die RoleArn Eigenschaft des AWS::Scheduler::Schedule Target Datentyps übergeben.

ScheduleExpression

Der Planungsausdruck, der bestimmt, wann und wie oft der Zeitplan ausgeführt wird.

Typ: Zeichenfolge

Erforderlich: Ja

AWS CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an die ScheduleExpression Eigenschaft einer AWS::Scheduler::Schedule Ressource übergeben.

ScheduleExpressionTimezone

Die Zeitzone, in der der Planungsausdruck ausgewertet wird.

Typ: Zeichenfolge

Required: No

AWS CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an die ScheduleExpressionTimezone Eigenschaft einer AWS::Scheduler::Schedule Ressource übergeben.

StartDate

Das Datum in UTC, nach dem der Zeitplan mit dem Aufrufen eines Ziels beginnen kann. Abhängig vom Wiederholungsausdruck des Zeitplans können Aufrufe an oder nach dem von Ihnen angegebenen StartDate erfolgen.

Typ: Zeichenfolge

Required: No

AWS CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an die StartDate Eigenschaft einer AWS::Scheduler::Schedule Ressource übergeben.

State

Der Status des Zeitplans.

Zulässige Werte: DISABLED | ENABLED

Typ: Zeichenfolge

Required: No

AWS CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an die State Eigenschaft einer AWS::Scheduler::Schedule Ressource übergeben.

Beispiele

Einfaches Beispiel für die Definition einer ScheduleV2-Ressource

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