Creazione di una regola di notifica

È possibile utilizzare le regole di notifica per notificare agli utenti quando si verificano modifiche importanti, ad esempio compilazioni riuscite o non andate a buon fine. Le regole di notifica specificano sia gli eventi che l'argomento Amazon SNS utilizzato per inviare le notifiche. Per ulteriori informazioni, vedere Cosa sono le notifiche?

Puoi utilizzare la console o AWS CLI per creare le regole di notifica per AWS CodeBuild.

Per creare una regola di notifica (console)

1. Accedi AWS Management Console e apri la CodeBuild console all'indirizzo https://console.aws.amazon.com/codebuild/.

2. Scegli Build, quindi Progetti build e poi scegli un progetto di build in cui desideri aggiungere le notifiche.

3. Nella pagina del progetto di compilazione, scegliere Notifica, quindi selezionare Crea regola di notifica. Puoi anche andare alla pagina Impostazioni per il progetto di build e scegliere Crea regola di notifica.

4. In Notification name (Nome notifica), immettere un nome per la regola.

5. In Tipo di dettaglio, scegli Basic se desideri che nella notifica siano EventBridge incluse solo le informazioni fornite ad Amazon. Scegli Completo se desideri includere le informazioni fornite ad Amazon EventBridge e le informazioni che potrebbero essere fornite da CodeBuild o dal gestore delle notifiche.

   Per ulteriori informazioni, vedere Informazioni sul contenuto delle notifiche e sulla sicurezza.

6. In Events that trigger notifications (Eventi che attivano le notifiche), selezionare gli eventi per i quali si desidera inviare notifiche. Per ulteriori informazioni, consulta l'argomento relativo agli eventi per le regole di notifica sui progetti di compilazione.

7. In Targets (Destinazioni), procedere in uno dei seguenti modi:

   • Se è già stata configurata una risorsa da utilizzare con le notifiche, in Choose target type (Scegli tipo di destinazione), scegliere AWS Chatbot (Slack) o SNS topic (Argomento SNS). In Scegli destinazione, scegli il nome del client (per un client Slack configurato inAWS Chatbot) o l'Amazon Resource Name (ARN) dell'argomento Amazon SNS (per gli argomenti Amazon SNS già configurati con la politica richiesta per le notifiche).

   • Se non è stata configurata una risorsa da utilizzare con le notifiche, scegliere Create target (Crea destinazione), e quindi scegliere SNS topic (Argomento SNS). Fornire un nome per l'argomento dopo codestar-notifications-, quindi scegliere Create (Crea).

   Nota

   • Se si crea l'argomento Amazon SNS come parte della creazione della regola di notifica, viene applicata la policy che consente alla funzionalità di notifica di pubblicare eventi nell'argomento. L'utilizzo di un argomento creato per le regole di notifica consente di iscrivere solo gli utenti che si desidera ricevano le notifiche relative a questa risorsa.

   • Non è possibile creare un client AWS Chatbot come parte della creazione di una regola di notifica. Se si sceglie AWS Chatbot (Slack), verrà visualizzato un pulsante che indirizza alla configurazione di un client AWS Chatbot. La scelta di tale opzione apre la console AWS Chatbot. Per ulteriori informazioni, consulta l'argomento relativo alla configurazione delle integrazioni tra le notifiche e AWS Chatbot.

   • Se desideri utilizzare un argomento Amazon SNS esistente come obiettivo, devi aggiungere la politica richiesta per AWS CodeStar le notifiche oltre a qualsiasi altra politica che potrebbe esistere per quell'argomento. Per ulteriori informazioni, consulta l'argomento relativo alla configurazione degli argomenti Amazon SNS per le notifiche e le informazioni sulla sicurezza e sui contenuti delle notifiche.

8. Per completare la creazione della regola, scegliere Invia.

9. È necessario iscrivere gli utenti all'argomento Amazon SNS relativo alla regola prima che possano ricevere notifiche. Per ulteriori informazioni, consulta Sottoscrivere gli utenti agli argomenti di Amazon SNS relativi agli obiettivi. Puoi anche configurare l'integrazione tra le notifiche e inviare notifiche AWS Chatbot alle chat room di Amazon Chime. Per ulteriori informazioni, vedere Configura l'integrazione tra notifiche e AWS Chatbot.

Per creare una regola di notifica (AWS CLI)

1. Da un terminale o dal prompt dei comandi, eseguire il comando create-notification rule per generare lo skeleton JSON:

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

   È possibile assegnare al file un nome qualsiasi. In questo esempio, il file è denominato rule.json.

2. Aprire il file JSON in un editor di testo normale e modificarlo per includere la risorsa, i tipi di evento e la destinazione desiderata per la regola. L'esempio seguente mostra una regola di notifica denominata MyNotificationRule per un progetto di compilazione denominato MyBuildProjectin un AWS account con l'ID 123456789012. Le notifiche vengono inviate con il tipo di dettaglio completo a un argomento di Amazon SNS denominato codestar-notifications, quando le build hanno esito positivo: MyNotificationTopic

   {
       "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"
   }

   Salva il file.

3. Utilizzando il file appena modificato, dal terminale o dalla riga di comando, eseguire nuovamente il comando create-notification-rule per creare la regola di notifica:

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

4. In caso di esito positivo, il comando restituisce l'ARN della regola di notifica, simile al seguente:

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