Membuat aturan notifikasi - AWS CodeBuild

Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

Membuat aturan notifikasi

Anda dapat menggunakan aturan notifikasi untuk memberi tahu pengguna saat terjadi perubahan penting, seperti keberhasilan dan kegagalan build. 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 CodeBuild.

Untuk membuat aturan notifikasi (konsol)

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

  2. Pilih Build, pilih Build projects, lalu pilih build project tempat Anda ingin menambahkan notifikasi.

  3. Pada halaman proyek build, pilih Beri tahu, lalu pilih Buat aturan notifikasi. Anda juga dapat membuka halaman Pengaturan untuk proyek build dan memilih Create notification rule.

  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 CodeBuild 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 Pemberitahuan tentang Proyek Pembuatan.

  7. Di Target, lakukan salah satu langkah berikut:

    • Jika Anda telah mengonfigurasi sumber daya untuk digunakan dengan notifikasi, di Pilih jenis target, pilih Pengembang Amazon Q di aplikasi obrolan (Slack) atau topik SNS. Di Pilih target, pilih nama klien (untuk klien Slack yang dikonfigurasi di Amazon Q Developer dalam aplikasi obrolan) atau Nama Sumber Daya Amazon (ARN) dari topik Amazon SNS (untuk topik Amazon SNS yang sudah dikonfigurasi dengan kebijakan yang diperlukan untuk pemberitahuan).

    • 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 Pengembang Amazon Q di klien aplikasi obrolan sebagai bagian dari pembuatan aturan notifikasi. Jika Anda memilih Pengembang Amazon Q dalam aplikasi obrolan (Slack), Anda akan melihat tombol yang mengarahkan Anda untuk mengonfigurasi klien di Amazon Q Developer dalam aplikasi obrolan. Memilih opsi itu membuka Pengembang Amazon Q di konsol aplikasi obrolan. Untuk informasi selengkapnya, lihat Mengonfigurasi Integrasi Antara Pemberitahuan dan Pengembang Amazon Q di aplikasi obrolan.

    • Jika Anda ingin menggunakan topik Amazon SNS 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 Konfigurasi Topik Amazon SNS untuk Notifikasi dan Memahami Konten Notifikasi dan Keamanan.

  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 Buat Pengguna Berlangganan ke Topik Amazon SNS yang Merupakan Target. Anda juga dapat mengatur integrasi antara notifikasi dan Pengembang Amazon Q di aplikasi obrolan untuk mengirim pemberitahuan ke ruang obrolan Amazon Chime. Untuk informasi selengkapnya, lihat Mengkonfigurasi Integrasi Antara Pemberitahuan dan Pengembang Amazon Q di aplikasi obrolan.

Membuat aturan notifikasi (AWS CLI)

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

    aws codestarnotifications create-notification-rule --generate-cli-skeleton > rule.json

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

  2. Buka file JSON dalam editor plaintext dan edit untuk memasukkan sumber daya, jenis peristiwa, dan target yang Anda inginkan untuk aturan tersebut. Contoh berikut menunjukkan aturan notifikasi bernama MyNotificationRule untuk proyek build bernama MyBuildProject AWS acccount dengan ID123456789012. Pemberitahuan dikirim dengan tipe detail lengkap ke topik Amazon SNS yang diberi nama codestar-notifications-MyNotificationTopic saat build berhasil:

    {
    "Name": "MyNotificationRule",
    "EventTypeIds": [
        "codebuild-project-build-state-succeeded"
    ],
    "Resource": "arn:aws:codebuild:us-east-2:123456789012:MyBuildProject",
    "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 codestarnotifications 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"
}