Membuat aturan notifikasi - Konsol Alat Developer

Membuat aturan notifikasi

Anda dapat menggunakan konsol Alat Developer atau AWS CLI untuk membuat aturan notifikasi. Anda dapat membuat untuk membuat topik Amazon SNS untuk digunakan sebagai target sebagai bagian dari pembuatan aturan. Jika Anda ingin menggunakan klien AWS Chatbot sebagai target, Anda harus membuat klien itu sebelum Anda dapat membuat aturan. Untuk informasi lebih lanjut, lihat Mengonfigurasi klien AWS Chatbot untuk saluran slack.

Untuk membuat aturan notifikasi (konsol)

  1. Buka konsol Alat Developer AWS di https://console.aws.amazon.com/codesuite/settings/notifications.

  2. Gunakan bilah navigasi untuk menavigasi ke sumber daya.

    • Untuk CodeBuild, pilih Membangun, pilih Membangun proyek, dan pilih membangun proyek.

    • Untuk CodeCommit, pilih Sumber, pilih Repositori, dan pilih repositori.

    • Untuk CodeDeploy, pilih Aplikasi, lalu pilih aplikasi.

    • Untuk CodePipeline, pilih Pipeline, pilih Alur, dan pilih alur.

  3. Pada halaman sumber daya, pilih Beri tahu, lalu pilih Buat aturan notifikasi. Anda juga dapat masuk ke halaman Pengaturan untuk sumber daya, masuk ke Notifikasi atau Aturan notifikasi, lalu pilih Membuat aturan notifikasi.

  4. Di Nama notifikasi, masukkan nama untuk aturan.

  5. Di Jenis detail, pilih Basic jika Anda ingin hanya informasi yang diberikan kepada Amazon EventBridge termasuk dalam notifikasi. Pilih Full jika Anda ingin menyertakan informasi yang diberikan kepada Amazon EventBridge dan informasi yang mungkin disediakan oleh layanan sumber daya atau manajer notifikasi.

    Untuk informasi lebih lanjut, lihat Memahami konten dan keamanan notifikasi.

  6. Di Peristiwa yang memicu notifikasi, pilih peristiwa yang ingin Anda kirimkan notifikasi. Untuk jenis peristiwa untuk sumber daya, lihat berikut ini:

  7. Di Target, lakukan salah satu langkah berikut:

    • Jika Anda telah mengonfigurasi sumber daya untuk digunakan dengan notifikasi, di Pilih tipe target, pilih salah satu dari AWS Chatbot (Slack) atau Topik SNS. Pi Pilih target, pilih nama klien (untuk klien Slack yang dikonfigurasi di AWS Chatbot) atau Amazon Resource Name (ARN) dari topik Amazon SNS (untuk topik Amazon SNS yang sudah dikonfigurasi dengan kebijakan yang diperlukan untuk notifikasi).

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

    catatan
    • Jika Anda membuat topik Amazon SNS sebagai bagian dari membuat aturan notifikasi, kebijakan yang memungkinkan fitur notifikasi untuk mempublikasikan peristiwa untuk topik 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 klien AWS Chatbot sebagai bagian dari membuat aturan notifikasi. Jika Anda memilih AWS Chatbot (Slack), Anda akan melihat tombol yang mengarahkan Anda untuk mengonfigurasi klien di AWS Chatbot. Memilih pilihan tersebut akan membuka konsol AWS Chatbot. Untuk informasi lebih lanjut, lihat Mengonfigurasi klien AWS Chatbot untuk saluran slack.

    • Jika Anda ingin menggunakan topik Amazon SNS yang sudah ada sebagai target, Anda harus menambahkan kebijakan yang diperlukan untuk Notifikasi AWS CodeStar selain kebijakan lain yang mungkin ada untuk topik itu. Untuk informasi lebih lanjut, lihat Mengonfigurasi topik Amazon SNS untuk notifikasi dan Memahami konten dan keamanan notifikasi.

  8. Pilih Kirim, dan kemudian tinjau aturan notifikasi.

    catatan

    Pengguna harus berlangganan dan mengonfirmasi langganan ke topik Amazon SNS yang Anda tentukan sebagai target aturan sebelum mereka akan menerima notifikasi. Untuk informasi lebih lanjut, lihat Untuk berlangganan pengguna ke topik Amazon SNS yang digunakan untuk notifikasi.

Membuat aturan notifikasi (AWS CLI)

  1. Di terminal atau permintaan 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 dalam editor plaintext dan edit untuk memasukkan sumber daya, jenis peristiwa, dan target Amazon SNS yang Anda inginkan untuk aturan.

    Contoh berikut menunjukkan aturan notifikasi bernama MyNotificationRule untuk repositori bernama MyDemorepo di akun AWS dengan ID 123456789012. Notifikasi dengan jenis detail lengkap dikirim ke topik Amazon SNS bernama MyNotificationTopic ketika cabang dan tanda 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.

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

    aws codestar-notifications create-notification-rule --cli-input-json file://rule.json
  4. Jika berhasil, perintah mengembalikan ARN aturan notifikasi, mirip dengan berikut ini.

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

Untuk mencantumkan jenis peristiwa untuk aturan notifikasi (AWS CLI)

  1. Di terminal atau permintaan perintah, jalankan perintah list-event-types. Anda dapat menggunakan pilihan --filters untuk membatasi respons ke jenis sumber daya tertentu atau atribut lainnya. Sebagai contoh, berikut mengembalikan daftar jenis peristiwa untuk aplikasi CodeDeploy.

    aws codestar-notifications list-event-types --filters Name=SERVICE_NAME,Value=CodeDeploy
  2. Perintah ini menghasilkan output yang serupa dengan yang berikut ini.

    { "EventTypes": [ { "EventTypeId": "codedeploy-application-deployment-succeeded", "ServiceName": "CodeDeploy", "EventTypeName": "Deployment: Succeeded", "ResourceType": "Application" }, { "EventTypeId": "codedeploy-application-deployment-failed", "ServiceName": "CodeDeploy", "EventTypeName": "Deployment: Failed", "ResourceType": "Application" }, { "EventTypeId": "codedeploy-application-deployment-started", "ServiceName": "CodeDeploy", "EventTypeName": "Deployment: Started", "ResourceType": "Application" } ] }

Untuk menambahkan tanda ke aturan notifikasi (AWS CLI)

  1. Di terminal atau permintaan perintah, jalankan perintah tag-resource. Sebagai contoh, gunakan perintah berikut untuk menambahkan tanda nilai kunci pasangan yang memiliki nama Tim dan nilai Li_Juan.

    aws codestar-notifications tag-resource --arn arn:aws:codestar-notifications:us-east-1:123456789012:notificationrule/fe1efd35-EXAMPLE --tags Team=Li_Juan
  2. Perintah ini menghasilkan output yang serupa dengan yang berikut ini.

    { "Tags": { "Team": "Li_Juan" } }