ScheduleV2

Objek yang menjelaskan jenis sumber ScheduleV2 peristiwa, yang menetapkan fungsi tanpa server Anda sebagai target peristiwa Amazon EventBridge Scheduler yang dipicu pada jadwal. Untuk informasi selengkapnya, lihat Apa itu Amazon EventBridge Scheduler? di Panduan Pengguna EventBridge Penjadwal.

AWS Serverless Application Model (AWS SAM) menghasilkan AWS::Scheduler::Schedulesumber daya saat jenis acara ini disetel.

Sintaks

Untuk mendeklarasikan entitas ini di AWS Serverless Application Model (AWS SAM) template, gunakan sintaks berikut.

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

Properti

DeadLetterConfig

Konfigurasikan antrian Amazon Simple Queue Service (AmazonSQS) tempat EventBridge mengirim peristiwa setelah pemanggilan target gagal. Pemanggilan dapat gagal, misalnya, saat mengirim acara ke fungsi Lambda yang tidak ada, atau ketika tidak EventBridge memiliki izin yang cukup untuk memanggil fungsi Lambda. Untuk informasi selengkapnya, lihat Mengonfigurasi antrian huruf mati untuk EventBridge Penjadwal di Panduan Pengguna Penjadwal. EventBridge

catatan

Jenis AWS::Serverless::Function sumber daya memiliki tipe data yang serupaDeadLetterQueue, yang menangani kegagalan yang terjadi setelah pemanggilan fungsi Lambda target berhasil. Contoh tipe kegagalan ini termasuk Lambda throttling, atau kesalahan yang dikembalikan oleh fungsi target Lambda. Untuk informasi selengkapnya tentang DeadLetterQueue properti fungsi, lihat Antrian huruf mati di AWS Lambda Panduan Pengembang.

Jenis: DeadLetterConfig

Wajib: Tidak

AWS CloudFormation kompatibilitas: Properti ini mirip dengan DeadLetterConfig properti tipe AWS::Scheduler::Schedule Target data. Bagian AWS SAM versi properti ini mencakup subproperti tambahan, jika Anda mau AWS SAM untuk membuat antrian surat mati untuk Anda.

Description

Deskripsi jadwal.

Tipe: String

Wajib: Tidak

AWS CloudFormation kompatibilitas: Properti ini diteruskan langsung ke Description properti AWS::Scheduler::Schedule sumber daya.

EndDate

Tanggal, diUTC, sebelum jadwal dapat memanggil targetnya. Bergantung pada ekspresi pengulangan jadwal, pemanggilan mungkin berhenti, atau sebelum, yang Anda tentukanEndDate.

Tipe: String

Wajib: Tidak

AWS CloudFormation kompatibilitas: Properti ini diteruskan langsung ke EndDate properti AWS::Scheduler::Schedule sumber daya.

FlexibleTimeWindow

Mengizinkan konfigurasi jendela di mana jadwal dapat dipanggil.

Jenis: FlexibleTimeWindow

Wajib: Tidak

AWS CloudFormation kompatibilitas: Properti ini diteruskan langsung ke FlexibleTimeWindow properti AWS::Scheduler::Schedule sumber daya.

GroupName

Nama grup jadwal untuk dikaitkan dengan jadwal ini. Jika tidak ditentukan, grup default digunakan.

Tipe: String

Wajib: Tidak

AWS CloudFormation kompatibilitas: Properti ini diteruskan langsung ke GroupName properti AWS::Scheduler::Schedule sumber daya.

Input

JSONTeks yang valid diteruskan ke target. Jika Anda menggunakan properti ini, tidak ada dari teks peristiwa itu sendiri yang diteruskan ke target.

Tipe: String

Wajib: Tidak

AWS CloudFormation kompatibilitas: Properti ini diteruskan langsung ke Input properti AWS::Scheduler::Schedule Target sumber daya.

KmsKeyArn

The ARN for a KMS Key yang akan digunakan untuk mengenkripsi data pelanggan.

Tipe: String

Wajib: Tidak

AWS CloudFormation kompatibilitas: Properti ini diteruskan langsung ke KmsKeyArn properti AWS::Scheduler::Schedule sumber daya.

Name

Nama jadwal. Jika Anda tidak menentukan nama, AWS SAM menghasilkan nama dalam format Function-Logical-IDEvent-Source-Name dan menggunakan ID itu untuk nama jadwal.

Tipe: String

Wajib: Tidak

AWS CloudFormation kompatibilitas: Properti ini diteruskan langsung ke Name properti AWS::Scheduler::Schedule sumber daya.

OmitName

Secara default, AWS SAM menghasilkan dan menggunakan nama jadwal dalam format <Function-logical-ID><event-source-name>. Tetapkan properti ini true untuk memiliki AWS CloudFormation buat ID fisik yang unik dan gunakan itu untuk nama jadwal sebagai gantinya.

Tipe: Boolean

Wajib: Tidak

Default: false

AWS CloudFormation kompatibilitas: Properti ini unik untuk AWS SAM dan tidak memiliki AWS CloudFormation setara.

PermissionsBoundary

Kebijakan ARN yang digunakan untuk menetapkan batas izin untuk peran tersebut.

catatan

Jika PermissionsBoundary didefinisikan, AWS SAM akan menerapkan batasan yang sama dengan IAM peran target jadwal penjadwal.

Tipe: String

Wajib: Tidak

AWS CloudFormation kompatibilitas: Properti ini diteruskan langsung ke PermissionsBoundary properti AWS::IAM::Role sumber daya.

RetryPolicy

Objek RetryPolicy yang menyertakan informasi tentang pengaturan kebijakan coba lagi.

Jenis: RetryPolicy

Wajib: Tidak

AWS CloudFormation kompatibilitas: Properti ini diteruskan langsung ke RetryPolicy properti tipe AWS::Scheduler::Schedule Target data.

RoleArn

ARNIAMPeran yang akan digunakan EventBridge Scheduler untuk target saat jadwal dipanggil.

Jenis: RoleArn

Wajib: Tidak

AWS CloudFormation kompatibilitas: Properti ini diteruskan langsung ke RoleArn properti tipe AWS::Scheduler::Schedule Target data.

ScheduleExpression

Ekspresi penjadwalan yang menentukan kapan dan seberapa sering acara jadwal penjadwal berjalan.

Tipe: String

Wajib: Ya

AWS CloudFormation kompatibilitas: Properti ini diteruskan langsung ke ScheduleExpression properti AWS::Scheduler::Schedule sumber daya.

ScheduleExpressionTimezone

Zona waktu di mana ekspresi penjadwalan dievaluasi.

Tipe: String

Wajib: Tidak

AWS CloudFormation kompatibilitas: Properti ini diteruskan langsung ke ScheduleExpressionTimezone properti AWS::Scheduler::Schedule sumber daya.

StartDate

Tanggal, diUTC, setelah itu jadwal dapat mulai memanggil target. Bergantung pada ekspresi pengulangan jadwal, pemanggilan mungkin terjadi pada, atau setelah, yang Anda tentukanStartDate.

Tipe: String

Wajib: Tidak

AWS CloudFormation kompatibilitas: Properti ini diteruskan langsung ke StartDate properti AWS::Scheduler::Schedule sumber daya.

State

Keadaan jadwal Scheduler.

Nilai yang diterima: DISABLED | ENABLED

Tipe: String

Wajib: Tidak

AWS CloudFormation kompatibilitas: Properti ini diteruskan langsung ke State properti AWS::Scheduler::Schedule sumber daya.

Contoh

Contoh dasar mendefinisikan sumber daya 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

catatan

ID fisik yang dihasilkan dari ScheduleV2 tidak menyertakan nama tumpukan.