Tutorial: Mengatur aturan CloudWatch Acara untuk menerima pemberitahuan email untuk perubahan status pipeline

Setelah menyiapkan pipeline AWS CodePipeline, Anda dapat menyiapkan aturan CloudWatch Acara untuk mengirim notifikasi setiap kali ada perubahan pada status eksekusi pipeline Anda, atau dalam tahapan atau tindakan di pipeline Anda. Untuk informasi selengkapnya tentang penggunaan CloudWatch Acara untuk mengatur notifikasi perubahan status pipeline, lihatMemantau CodePipeline peristiwa.

Dalam tutorial ini, Anda mengonfigurasi notifikasi untuk mengirim email saat status pipeline berubah menjadi GAGAL. Tutorial ini menggunakan metode transformator masukan saat membuat aturan CloudWatch Events. Ini mengubah rincian skema pesan untuk menyampaikan pesan dalam teks yang dapat dibaca manusia.

catatan

Saat Anda membuat sumber daya untuk tutorial ini, seperti notifikasi Amazon SNS dan aturan CloudWatch Acara, pastikan sumber daya dibuat di AWS Wilayah yang sama dengan pipeline Anda.

Langkah 1: Siapkan notifikasi email menggunakan Amazon SNS

Amazon SNS mengoordinasikan penggunaan topik untuk mengirimkan pesan ke titik akhir atau klien berlangganan. Gunakan Amazon SNS untuk membuat topik notifikasi dan kemudian berlangganan topik menggunakan alamat email Anda. Topik Amazon SNS akan ditambahkan sebagai target ke aturan CloudWatch Acara Anda. Untuk informasi lebih lanjut, lihat Panduan Developer Layanan Notifikasi Sederhana Amazon.

Buat atau identifikasi topik di Amazon SNS. CodePipeline akan menggunakan CloudWatch Acara untuk mengirim pemberitahuan ke topik ini melalui Amazon SNS. Untuk membuat topik:

1. Buka konsol Amazon SNS di https://console.aws.amazon.com/sns.

2. Pilih Buat topik.

3. Dalam kotak dialog Buat topik baru, untuk nama Topik, ketikkan nama untuk topik (misalnya,PipelineNotificationTopic).

   

4. Pilih Buat topik.

   Untuk informasi selengkapnya, lihat Membuat Topik di Panduan Pengembang Amazon SNS.

Berlangganan satu atau beberapa penerima ke topik untuk menerima pemberitahuan email. Untuk berlangganan penerima ke suatu topik:

1. Di konsol Amazon SNS, dari daftar Topik, pilih kotak centang di sebelah topik baru Anda. Pilih Tindakan, Berlangganan topik.

2. Di kotak dialog Buat langganan, verifikasi bahwa ARN muncul di Topik ARN.

3. Untuk Protokol, pilih Email.

4. Untuk Endpoint, ketik alamat email lengkap penerima.

5. Pilih Buat Langganan.

6. Amazon SNS mengirimkan email konfirmasi berlangganan ke penerima. Untuk menerima pemberitahuan email, penerima harus memilih tautan Konfirmasi langganan di email ini. Setelah penerima mengklik tautan, jika berhasil berlangganan, Amazon SNS menampilkan pesan konfirmasi di browser web penerima.

   Untuk informasi selengkapnya, lihat Berlangganan Topik di Panduan Pengembang Amazon SNS.

Langkah 2: Buat aturan dan tambahkan topik SNS sebagai target

Buat aturan pemberitahuan CloudWatch Acara dengan CodePipeline sebagai sumber acara.

1. Buka CloudWatch konsol di https://console.aws.amazon.com/cloudwatch/.

2. Di panel navigasi, pilih Peristiwa.

3. Pilih Buat aturan. Di bawah Sumber acara, pilih AWS CodePipeline. Untuk Jenis Peristiwa, pilih Perubahan Status Eksekusi Pipeline.

4. Pilih Status spesifik, dan pilihFAILED.

5. Pilih Edit untuk membuka editor JSON untuk panel Pratinjau Pola Acara. Tambahkan pipeline parameter dengan nama pipeline Anda seperti yang ditunjukkan pada contoh berikut untuk pipeline bernama “MyPipeline.”

   Anda dapat menyalin pola acara di sini dan menempelkannya ke konsol:

   {
     "source": [
       "aws.codepipeline"
     ],
     "detail-type": [
       "CodePipeline Pipeline Execution State Change"
     ],
     "detail": {
       "state": [
         "FAILED"
       ],
       "pipeline": [
         "myPipeline"
       ]
     }
   }

6. Untuk Targets (Target), pilih Add target (Tambahkan target).

7. Dalam daftar target, pilih topik SNS. Untuk Topik, masukkan topik yang Anda buat.

8. Perluas Konfigurasi input, lalu pilih Input Transformer.

9. Dalam kotak Input Path, ketik pasangan kunci-nilai berikut.

   { "pipeline" : "$.detail.pipeline" }

   Dalam kotak Template Input, ketik berikut ini:

   "The Pipeline <pipeline> has failed."

10. Pilih Konfigurasikan detail.

11. Pada halaman Konfigurasi detail aturan, ketikkan nama dan deskripsi opsional. Untuk Status, biarkan kotak Diaktifkan dipilih.

12. Pilih Buat aturan.

13. Konfirmasikan bahwa CodePipeline sekarang mengirim pemberitahuan build. Misalnya, periksa untuk melihat apakah email pemberitahuan build sekarang ada di kotak masuk Anda.

14. Untuk mengubah perilaku aturan, di CloudWatch konsol, pilih aturan, lalu pilih Tindakan, Edit. Edit aturan, pilih Konfigurasikan detail, lalu pilih Perbarui aturan.

    Untuk berhenti menggunakan aturan untuk mengirim pemberitahuan build, di CloudWatch konsol, pilih aturan, lalu pilih Tindakan, Nonaktifkan.

    Untuk menghapus aturan, di CloudWatch konsol, pilih aturan, lalu pilih Tindakan, Hapus.

Langkah 3: Bersihkan Sumber Daya

Setelah Anda menyelesaikan tutorial ini, Anda harus menghapus pipeline dan sumber daya yang digunakannya sehingga Anda tidak akan dikenakan biaya untuk terus menggunakan sumber daya tersebut.

Untuk informasi tentang cara membersihkan notifikasi SNS dan menghapus aturan Amazon CloudWatch Events, lihat Membersihkan (Berhenti berlangganan dari Topik Amazon SNS) dan referensi DeleteRule di Referensi API Acara CloudWatch Amazon.