ScheduleV2 - 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.

ScheduleV2

Objek yang menjelaskan jenis sumber ScheduleV2 peristiwa, yang menetapkan mesin status 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 dalam template AWS Serverless Application Model (AWS SAM) Anda, gunakan sintaks berikut.

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 Mengonfigurasi antrian huruf mati untuk EventBridge Penjadwal di Panduan Pengguna Penjadwal. EventBridge

Jenis: DeadLetterConfig

Wajib: Tidak

AWS CloudFormation kompatibilitas: Properti ini mirip dengan DeadLetterConfig properti tipe AWS::Scheduler::Schedule Target data. AWS SAM Versi properti ini mencakup subproperti tambahan, jika Anda AWS SAM ingin membuat antrean huruf 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, di UTC, 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

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::Scheduler::Schedule Target sumber daya.

KmsKeyArn

ARN untuk Kunci KMS 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 buat nama dalam format StateMachine-Logical-IDEvent-Source-Name dan gunakan ID tersebut 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 <S tate-machine-logical event-source-name -ID>< >. Tetapkan properti ini true agar AWS CloudFormation menghasilkan ID fisik yang unik dan gunakan itu untuk nama jadwal sebagai gantinya.

Tipe: Boolean

Wajib: Tidak

Default: false

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

PermissionsBoundary

ARN kebijakan yang digunakan untuk mengatur batas izin untuk peran.

catatan

Jika PermissionsBoundary didefinisikan, AWS SAM akan menerapkan batasan yang sama untuk peran IAM 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

ARN dari peran IAM 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 jadwal 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, di UTC, 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

Status jadwal.

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

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