Schedule - AWS Serverless Application Model
SintaksPropertiContoh

Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

Schedule

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

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

catatan

EventBridge sekarang menawarkan kemampuan penjadwalan baru, Amazon EventBridge Scheduler. Amazon EventBridge Scheduler adalah penjadwal tanpa server yang memungkinkan Anda membuat, menjalankan, dan mengelola tugas dari satu layanan terpusat yang dikelola. EventBridge Scheduler sangat dapat disesuaikan, dan menawarkan skalabilitas yang ditingkatkan dibandingkan aturan EventBridge terjadwal, dengan serangkaian operasi API target yang lebih luas dan. Layanan AWS

Kami menyarankan Anda menggunakan EventBridge Scheduler untuk memanggil target pada jadwal. Untuk menentukan jenis sumber acara ini di AWS SAM templat Anda, lihatScheduleV2.

Sintaks

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

YAML

  DeadLetterConfig: DeadLetterConfig
  Description: String
  Enabled: Boolean
  Input: String
  Name: String
  RetryPolicy: RetryPolicy
  Schedule: String
  State: String

Properti

DeadLetterConfig

Konfigurasikan antrian Amazon Simple Queue Service (Amazon SQS) EventBridge tempat pengiriman 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 Kebijakan percobaan ulang acara dan menggunakan antrian huruf mati di Panduan Pengguna Amazon. 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 Panduan Pengembang.AWS Lambda

Jenis: DeadLetterConfig

Wajib: Tidak

AWS CloudFormation kompatibilitas: Properti ini mirip dengan DeadLetterConfig properti tipe AWS::Events::Rule Target data. AWS SAM Versi properti ini mencakup subproperti tambahan, jika Anda AWS SAM ingin membuat antrean huruf mati untuk Anda.

Description

Deskripsi aturan.

Tipe: String

Wajib: Tidak

AWS CloudFormation kompatibilitas: Properti ini diteruskan langsung ke Description properti AWS::Events::Rule sumber daya.

Enabled

Menunjukkan apakah aturan diaktifkan.

Untuk menonaktifkan aturan, tetapkan properti ini ke false.

catatan

Tentukan salah satu Enabled atau State properti, tetapi tidak keduanya.

Tipe: Boolean

Wajib: Tidak

AWS CloudFormation kompatibilitas: Properti ini mirip dengan State properti AWS::Events::Rule sumber daya. Jika properti ini diatur untuk true kemudian AWS SAM lolosENABLED, jika tidak maka akan lewatDISABLED.

Input

Teks JSON yang valid yang dilewatkan 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::Events::Rule Target sumber daya.

Name

Nama aturan. Jika Anda tidak menentukan nama, AWS CloudFormation buat ID fisik unik dan gunakan ID tersebut untuk nama aturan.

Tipe: String

Wajib: Tidak

AWS CloudFormation kompatibilitas: Properti ini diteruskan langsung ke Name properti AWS::Events::Rule sumber daya.

RetryPolicy

Objek RetryPolicy yang menyertakan informasi tentang pengaturan kebijakan coba lagi. Untuk informasi selengkapnya, lihat Kebijakan percobaan ulang acara dan menggunakan antrian huruf mati di Panduan Pengguna Amazon. EventBridge

Jenis: RetryPolicy

Wajib: Tidak

AWS CloudFormation kompatibilitas: Properti ini diteruskan langsung ke RetryPolicy properti tipe AWS::Events::Rule Target data.

Schedule

Ekspresi penjadwalan yang menentukan kapan dan seberapa sering aturan dijalankan. Untuk informasi lebih lanjut, lihat Ekspresi Jadwal untuk Aturan.

Tipe: String

Wajib: Ya

AWS CloudFormation kompatibilitas: Properti ini diteruskan langsung ke ScheduleExpression properti AWS::Events::Rule sumber daya.

State

Keadaan aturan.

Nilai yang diterima: DISABLED | ENABLED

catatan

Tentukan salah satu Enabled atau State properti, tetapi tidak keduanya.

Tipe: String

Wajib: Tidak

AWS CloudFormation kompatibilitas: Properti ini diteruskan langsung ke State properti AWS::Events::Rule sumber daya.

Contoh

CloudWatch Jadwal Acara

CloudWatch Jadwal Event Contoh

YAML

CWSchedule:
  Type: Schedule
  Properties:
    Schedule: 'rate(1 minute)'
    Name: TestSchedule
    Description: test schedule
    Enabled: false