Membuat aturan notifikasi

Anda dapat menggunakan aturan notifikasi untuk memberitahu pengguna perubahan penting, seperti ketika permintaan tarik dibuat dalam sebuah repositori. Aturan notifikasi menentukan peristiwa dan SNS topik Amazon yang digunakan untuk mengirim notifikasi. Untuk informasi selengkapnya, lihat Apa itu notifikasi?

catatan

Fitur ini tidak tersedia di Wilayah Eropa (Milan). Untuk mempelajari cara mengonfigurasi notifikasi dalam pengalaman yang tersedia di Wilayah tersebut, lihat Mengkonfigurasi Notifikasi Repository.

Anda dapat menggunakan konsol atau AWS CLI untuk membuat aturan notifikasi untuk AWS CodeCommit.

Untuk membuat aturan notifikasi (konsol)

1. Masuk ke AWS Management Console dan buka CodeCommit konsol di https://console.aws.amazon.com/codecommit/.

2. Pilih Repositori, dan kemudian pilih repositori tempat Anda ingin menambahkan aturan notifikasi.

3. Pada halaman repositori, pilih Beritahu, lalu pilih Buat aturan notifikasi. Anda juga dapat pergi ke Pengaturan untuk repositori tersebut dan pilih Buat aturan notifikasi.

4. Di Nama notifikasi, masukkan nama untuk aturan.

5. Di Jenis detail, pilih Dasar jika Anda hanya menginginkan informasi yang diberikan ke Amazon yang EventBridge disertakan dalam notifikasi. Pilih Lengkap jika Anda ingin menyertakan informasi yang diberikan ke Amazon EventBridge dan informasi yang mungkin diberikan oleh CodeCommit atau pengelola notifikasi.

   Untuk informasi selengkapnya, lihat Memahami Konten Notifikasi dan Keamanan.

6. Di Peristiwa yang memicu notifikasi, pilih peristiwa yang ingin Anda kirimkan notifikasi. Untuk informasi selengkapnya, lihat Peristiwa untuk Aturan Notifikasi di Repositori.

7. Di Target, lakukan salah satu langkah berikut:

   • Jika Anda telah mengonfigurasi sumber daya untuk digunakan dengan notifikasi, di Pilih jenis target, pilih salah satu AWS Chatbot (Slack) atau SNStopik. Di Pilih target, pilih nama klien (untuk klien Slack yang dikonfigurasi AWS Chatbot) atau Nama Sumber Daya Amazon (ARN) dari topik Amazon (untuk SNS topik Amazon yang sudah dikonfigurasi dengan kebijakan yang diperlukan untuk pemberitahuan). SNS

   • Jika Anda belum mengonfigurasi sumber daya untuk digunakan dengan notifikasi, pilih Buat target, lalu pilih SNStopik. Berikan nama untuk topik setelah codestar-notifications-, lalu pilih Buat.

   catatan

   • Jika Anda membuat SNS topik Amazon sebagai bagian dari pembuatan aturan notifikasi, kebijakan yang mengizinkan fitur notifikasi untuk mempublikasikan peristiwa ke topik akan diterapkan untuk Anda. Menggunakan topik yang dibuat untuk aturan notifikasi membantu memastikan bahwa Anda hanya berlangganan pengguna yang ingin Anda terima notifikasinya tentang sumber daya ini.

   • Anda tidak dapat membuat AWS Chatbot klien sebagai bagian dari pembuatan aturan notifikasi. Jika Anda memilih AWS Chatbot (Slack), Anda akan melihat tombol yang mengarahkan Anda untuk mengkonfigurasi klien. AWS Chatbot Memilih opsi itu membuka AWS Chatbot konsol. Untuk informasi selengkapnya, lihat Mengkonfigurasi Integrasi Antara Pemberitahuan dan AWS Chatbot.

   • Jika ingin menggunakan SNS topik Amazon yang ada sebagai target, Anda harus menambahkan kebijakan yang diperlukan untuk AWS CodeStar Pemberitahuan selain kebijakan lain yang mungkin ada untuk topik tersebut. Untuk informasi selengkapnya, lihat Mengonfigurasi SNS Topik Amazon untuk Pemberitahuan dan Memahami Konten dan Keamanan Pemberitahuan.

8. Untuk menyelesaikan pembuatan aturan, pilih Kirim.

9. Anda harus berlangganan pengguna ke SNS topik Amazon untuk aturan sebelum mereka dapat menerima pemberitahuan. Untuk informasi selengkapnya, lihat Berlangganan Pengguna ke SNS Topik Amazon yang Menjadi Target. Anda juga dapat mengatur integrasi antara notifikasi dan mengirim notifikasi AWS Chatbot ke ruang obrolan Amazon Chime. Untuk informasi selengkapnya, lihat Mengkonfigurasi Integrasi Antara Pemberitahuan dan AWS Chatbot.

Membuat aturan notifikasi (AWS CLI)

1. Pada terminal atau command prompt, jalankan create-notification rule perintah untuk menghasilkan JSON kerangka:

   aws codestar-notifications create-notification-rule --generate-cli-skeleton > rule.json

   Anda dapat memberi nama file apa pun yang Anda inginkan. Dalam contoh ini, file tersebut diberi nama rule.json.

2. Buka JSON file di editor teks biasa dan edit untuk menyertakan sumber daya, jenis acara, dan target yang Anda inginkan untuk aturan tersebut. Contoh berikut menunjukkan aturan notifikasi bernama MyNotificationRule untuk repositori bernama MyDemoRepo dalam AWS acccount dengan ID 123456789012. Pemberitahuan dengan jenis detail lengkap dikirim ke SNS topik Amazon bernama MyNotificationTopic saat cabang dan tag dibuat:

   {
       "Name": "MyNotificationRule",
       "EventTypeIds": [
           "codecommit-repository-branches-and-tags-created"
       ],
       "Resource": "arn:aws:codecommit:us-east-1:123456789012:MyDemoRepo",
       "Targets": [
           {
               "TargetType": "SNS",
               "TargetAddress": "arn:aws:sns:us-east-1:123456789012:MyNotificationTopic"
           }
       ],
       "Status": "ENABLED",
       "DetailType": "FULL"
   }

   Simpan file tersebut.

3. Menggunakan file yang baru saja Anda edit, di terminal atau baris perintah, jalankan create-notification-rule perintah lagi untuk membuat aturan notifikasi:

   aws codestar-notifications create-notification-rule --cli-input-json  file://rule.json

4. Jika berhasil, perintah mengembalikan aturan ARN notifikasi, mirip dengan yang berikut ini:

   {
       "Arn": "arn:aws:codestar-notifications:us-east-1:123456789012:notificationrule/dc82df7a-EXAMPLE"
   }