ScheduleV2 - AWS Serverless Application Model
SyntaxEigenschaftenBeispiele

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

ScheduleV2

Das Objekt, das einen ScheduleV2 Ereignisquellentyp beschreibt, der Ihre Serverless-Funktion 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 AWS Serverless Application Model (AWS SAM)-Vorlage zu deklarieren.

Eigenschaften

DeadLetterConfig

Konfigurieren Sie die Amazon Simple Queue Service (Amazon SQS)-Warteschlange, in der Ereignisse nach einem fehlgeschlagenen Zielaufruf EventBridge sendet. Der Aufruf kann beispielsweise fehlschlagen, wenn ein Ereignis an eine nicht vorhandene Lambda-Funktion gesendet wird oder wenn nicht über ausreichende Berechtigungen zum Aufrufen der Lambda-Funktion EventBridge verfügt. Weitere Informationen finden Sie unter Konfigurieren einer Warteschlange für unzustellbare Nachrichten für EventBridge Scheduler im EventBridge Scheduler-Benutzerhandbuch.

Anmerkung

Der AWS::Serverless::Function Ressourcentyp hat einen ähnlichen Datentyp, DeadLetterQueue, der Fehler behandelt, die nach erfolgreichem Aufruf der Lambda-Zielfunktion auftreten. Beispiele für diese Arten von Fehlern sind Lambda-Drosselung oder Fehler, die von der Lambda-Zielfunktion zurückgegeben werden. Weitere Informationen zur -DeadLetterQueueFunktionseigenschaft finden Sie unter Warteschlangen für unzustellbare Nachrichten im -AWS LambdaEntwicklerhandbuch.

Geben Sie ein: 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, falls Sie die Warteschlange für unzustellbare Nachrichten für Sie AWS SAM erstellen möchten.

Description

Eine Beschreibung des Zeitplans.

Typ: Zeichenfolge

Required: No

AWS CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an die -DescriptionEigenschaft einer -AWS::Scheduler::ScheduleRessource ü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 -EndDateEigenschaft einer -AWS::Scheduler::ScheduleRessource übergeben.

FlexibleTimeWindow

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

Geben Sie ein: FlexibleTimeWindow

Required: No

AWS CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an die -FlexibleTimeWindowEigenschaft einer -AWS::Scheduler::ScheduleRessource ü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 -GroupNameEigenschaft einer -AWS::Scheduler::ScheduleRessource ü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 -InputEigenschaft einer -AWS::Scheduler::Schedule TargetRessource übergeben.

KmsKeyArn

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

Typ: Zeichenfolge

Required: No

AWS CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an die -KmsKeyArnEigenschaft einer -AWS::Scheduler::ScheduleRessource übergeben.

Name

Der Name des Plans. Wenn Sie keinen Namen angeben, AWS SAM generiert einen Namen im Format Function-Logical-IDEvent-Source-Name und verwendet diese ID für den Zeitplannamen.

Typ: Zeichenfolge

Required: No

AWS CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an die -NameEigenschaft einer -AWS::Scheduler::ScheduleRessource übergeben.

OmitName

Standardmäßig AWS SAM generiert und verwendet einen Zeitplannamen im Format <Function-logical-ID microSDevent-source-name>. Legen Sie diese Eigenschaft auf festtrue, damit eine eindeutige physische ID AWS CloudFormation generiert und diese stattdessen für den Zeitplannamen verwendet.

Typ: Boolesch

Required: No

Standardwert: false

AWS CloudFormation Kompatibilität: Diese Eigenschaft ist eindeutig 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 definiert PermissionsBoundary ist, AWS SAM wendet dieselben Grenzen auf die Ziel-IAM-Rolle des Schedulers an.

Typ: Zeichenfolge

Required: No

AWS CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an die -PermissionsBoundaryEigenschaft einer -AWS::IAM::RoleRessource übergeben.

RetryPolicy

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

Geben Sie ein: 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 EventBridge Scheduler für das Ziel verwendet, wenn der Zeitplan aufgerufen wird.

Geben Sie ein: 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 das Scheduler-Zeitplanereignis ausgeführt wird.

Typ: Zeichenfolge

Erforderlich: Ja

AWS CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an die -ScheduleExpressionEigenschaft einer -AWS::Scheduler::ScheduleRessource übergeben.

ScheduleExpressionTimezone

Die Zeitzone, in der der Planungsausdruck ausgewertet wird.

Typ: Zeichenfolge

Required: No

AWS CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an die -ScheduleExpressionTimezoneEigenschaft einer -AWS::Scheduler::ScheduleRessource ü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 -StartDateEigenschaft einer -AWS::Scheduler::ScheduleRessource übergeben.

State

Der Status des Scheduler-Zeitplans.

Zulässige Werte: DISABLED | ENABLED

Typ: Zeichenfolge

Required: No

AWS CloudFormation Kompatibilität: Diese Eigenschaft wird direkt an die -StateEigenschaft einer -AWS::Scheduler::ScheduleRessource übergeben.

Beispiele

Grundlegendes Beispiel für die Definition einer ScheduleV2-Ressource

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