Membuat aturan notifikasi

Anda dapat menggunakan aturan notifikasi untuk memberi tahu pengguna ketika ada perubahan pada aplikasi penerapan, seperti keberhasilan dan kegagalan penerapan. Aturan notifikasi menentukan peristiwa dan topik Amazon SNS yang digunakan untuk mengirim notifikasi. Untuk informasi selengkapnya, lihat Apa itu notifikasi?

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

Untuk membuat aturan notifikasi (konsol)

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

2. Pilih Aplikasi, lalu pilih aplikasi tempat Anda ingin menambahkan notifikasi.

3. Pada halaman aplikasi, pilih Beri tahu, lalu pilih Buat aturan pemberitahuan. Anda juga dapat pergi ke halaman Pengaturan untuk aplikasi dan memilih Buat aturan pemberitahuan.

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 CodeDeploy atau pengelola notifikasi.

   Untuk informasi selengkapnya, lihat Memahami konten dan keamanan notifikasi.

6. Di Peristiwa yang memicu notifikasi, pilih peristiwa yang ingin Anda kirimkan notifikasi.

   Kategori	Peristiwa
   Deployment	Gagal Berhasil Dimulai

7. Di Target, pilih Buat topik SNS.

   catatan

   Saat Anda membuat topik, kebijakan yang memungkinkan CodeDeploy untuk mempublikasikan acara ke topik diterapkan untuk Anda. Menggunakan topik yang dibuat khusus untuk CodeDeploy notifikasi juga membantu memastikan bahwa Anda hanya menambahkan pengguna ke daftar langganan untuk topik yang ingin Anda lihat pemberitahuan tentang aplikasi penerapan ini.

   Setelah prefiks codestar-notifications-, masukkan nama untuk topik, lalu pilih nama, lalu pilih Kirim.

   catatan

   Jika Anda ingin menggunakan topik Amazon SNS yang sudah ada alih-alih membuat yang baru, di Target, pilih ARN-nya. Pastikan topik memiliki kebijakan akses yang sesuai dan bahwa daftar pelanggan hanya berisi pengguna yang diizinkan untuk melihat informasi tentang aplikasi penyebaran. Untuk informasi selengkapnya, lihat Mengonfigurasi topik Amazon SNS yang ada untuk notifikasi serta Memahami konten dan keamanan notifikasi.

8. Untuk menyelesaikan pembuatan aturan, pilih Kirim.

9. Anda harus membuat pengguna berlangganan ke topik Amazon SNS untuk aturan tersebut sebelum mereka dapat menerima notifikasi. Untuk informasi selengkapnya, lihat Berlangganan pengguna ke topik Amazon SNS yang menjadi target. Anda juga dapat mengatur integrasi antara notifikasi dan mengirim notifikasi AWS Chatbot ke ruang obrolan Amazon Chime atau saluran Slack. Untuk informasi selengkapnya, lihat Mengonfigurasi integrasi antara notifikasi dan AWS Chatbot.

Membuat aturan notifikasi (AWS CLI)

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

   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 diberi nama rule.json.

2. Buka file JSON di editor teks biasa dan edit untuk menyertakan sumber daya, jenis acara, dan target Amazon SNS yang Anda inginkan untuk aturan tersebut. Contoh berikut menunjukkan aturan notifikasi bernama MyNotificationRule untuk aplikasi bernama MyDeploymentApplicationdalam AWS acccount dengan ID 123456789012. Pemberitahuan dikirim dengan tipe detail lengkap ke topik Amazon SNS bernama codestar-notifications- MyNotificationTopic saat penerapan berhasil:

   {
       "Name": "MyNotificationRule",
       "EventTypeIds": [
           "codedeploy-application-deployment-succeeded"
       ],
       "Resource": "arn:aws:codebuild:us-east-2:123456789012:MyDeploymentApplication",
       "Targets": [
           {
               "TargetType": "SNS",
               "TargetAddress": "arn:aws:sns:us-east-2:123456789012:codestar-notifications-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 tersebut mengembalikan ARN aturan notifikasi, yang serupa dengan berikut ini:

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