EventBridgeRule

Objek yang menjelaskan jenis sumber EventBridgeRule peristiwa, yang menetapkan fungsi tanpa server Anda sebagai target aturan Amazon. EventBridge Untuk informasi lebih lanjut, lihat Apa itu Amazon EventBridge? di Panduan EventBridge Pengguna Amazon.

AWS SAM menghasilkan sumber AWS::Events::Ruledaya saat jenis acara ini disetel.

Sintaks

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

YAML

  DeadLetterConfig: DeadLetterConfig
  EventBusName: String
  Input: String
  InputPath: String
  InputTransformer: InputTransformer
  Pattern: EventPattern
  RetryPolicy: RetryPolicy
  RuleName: String 
  State: String
  Target: Target

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.

EventBusName

Bus peristiwa yang akan dihubungkan dengan aturan ini. Jika Anda menghilangkan properti ini, AWS SAM gunakan bus acara default.

Tipe: String

Wajib: Tidak

Default: Bus peristiwa default

AWS CloudFormation kompatibilitas: Properti ini diteruskan langsung ke EventBusName properti AWS::Events::Rule 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::Events::Rule Target sumber daya.

InputPath

Bila Anda tidak ingin meneruskan seluruh peristiwa yang sesuai ke target, gunakan properti InputPath untuk menggambarkan bagian mana dari peristiwa yang akan diteruskan.

Tipe: String

Wajib: Tidak

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

InputTransformer

Pengaturan untuk memungkinkan Anda memberikan input kustom ke target berdasarkan data peristiwa tertentu. Anda dapat mengekstrak satu atau beberapa pasangan nilai kunci dari peristiwa dan kemudian menggunakan data tersebut untuk mengirim input yang disesuaikan ke target. Untuk informasi selengkapnya, lihat Transformasi EventBridge input Amazon di Panduan EventBridge Pengguna Amazon.

Jenis: InputTransformer

Wajib: Tidak

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

Pattern

Menjelaskan peristiwa yang dirutekan ke target yang ditentukan. Untuk informasi selengkapnya, lihat EventBridgeperistiwa Amazon dan pola EventBridge acara di Panduan EventBridge Pengguna Amazon.

Jenis: EventPattern

Wajib: Ya

AWS CloudFormation kompatibilitas: Properti ini diteruskan langsung ke EventPattern 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.

RuleName

Nama aturan.

Tipe: String

Wajib: Tidak

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

State

Keadaan aturan.

Nilai yang diterima: DISABLED | ENABLED

Tipe: String

Wajib: Tidak

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

Target

Sumber AWS daya yang EventBridge dipanggil ketika aturan dipicu. Anda dapat menggunakan properti ini untuk menentukan ID logis dari target. Jika properti ini tidak ditentukan, maka AWS SAM menghasilkan ID logis dari target.

Tipe: Target

Wajib: Tidak

AWS CloudFormation kompatibilitas: Properti ini mirip dengan Targets properti AWS::Events::Rule sumber daya. Versi AWS SAM properti ini hanya mengizinkan Anda untuk menentukan ID logis dari satu target.

Contoh

EventBridgeRule

Berikut adalah contoh tipe sumber peristiwa EventBridgeRule.

YAML

EBRule:
  Type: EventBridgeRule
  Properties:
    Input: '{"Key": "Value"}'
    Pattern:
      detail:
        state:
          - terminated
    RetryPolicy:
      MaximumRetryAttempts: 5
      MaximumEventAgeInSeconds: 900
    DeadLetterConfig:
      Type: SQS
      QueueLogicalId: EBRuleDLQ
    Target:
      Id: MyTarget