Creación de una regla de notificación

Puede utilizar reglas de notificación para notificar a los usuarios cuando se producen cambios importantes, como éxitos y errores de compilación. Las reglas de notificación especifican tanto los eventos como el tema de Amazon SNS que se utiliza para enviar notificaciones. Para obtener más información, consulte ¿Qué son las notificaciones?

Puede utilizar la consola o la AWS CLI para crear reglas de notificación para AWS CodeBuild.

Para crear una regla de notificación (consola)

1. Inicie sesión en la AWS Management Console y abra la consola de CodeBuild en https://console.aws.amazon.com/codebuild/.

2. Elija Compilar, elija Proyectos de compilación y, a continuación, seleccione un proyecto de compilación en el que desee agregar notificaciones.

3. En la página del proyecto de compilación, elija Notificar y, a continuación, elija Crear regla de notificación. También puede ir a la página Configuración del proyecto de compilación y elegir Crear regla de notificación.

4. En Nombre de la notificación, introduzca un nombre para la regla.

5. En Tipo de detalle, elija Básico si desea que solo la información proporcionada en Amazon EventBridge se incluya en la notificación. Elija Completo si desea incluir la información proporcionada en Amazon EventBridge y otra información que CodePipeline o el administrador de notificaciones podría suministrar.

   Para obtener más información, consulte Descripción del contenido y la seguridad de las notificaciones.

6. En Eventos que activan notificaciones, seleccione los eventos para los que desea enviar notificaciones. Para obtener más información, consulte Eventos de reglas de notificación en proyectos de compilación.

7. En Destinos, realice una de las siguientes operaciones:

   • Si ya ha configurado un recurso para utilizarlo con notificaciones, en Elegir tipo de destino elija AWS ChatbotSlack o Tema de SNS. En Elegir destino, elija el nombre del cliente (para un cliente de Slack configurado en AWS Chatbot) o el nombre de recurso de Amazon (ARN) del tema de Amazon SNS (para los temas de Amazon SNS ya configurados con la política necesaria para las notificaciones).

   • Si no ha configurado un recurso para utilizarlo con notificaciones, elija Crear destino y, a continuación, elija Tema de SNS. Indique el nombre del tema después de codestar-notifications- y, a continuación, elija Crear.

   nota

   • Si crea el tema de Amazon SNS durante la creación de la regla de notificación, se aplica la política que permite a la característica de notificaciones publicar eventos en el tema. El uso de un tema creado para las reglas de notificación lo ayuda a garantizar que solo suscriba a los usuarios que desea recibir notificaciones sobre este recurso.

   • No se puede crear un cliente de AWS Chatbot durante la creación de una regla de notificación. Si elige AWS Chatbot (Slack), aparecerá un botón que le llevará a configurar un cliente en AWS Chatbot. Al elegir esa opción, se abrirá la consola de AWS Chatbot. Para obtener más información, consulte Configurar la integración entre notificaciones y AWS Chatbot.

   • Si desea utilizar un tema de Amazon SNS ya existente como destino, debe agregar la política necesaria para las notificaciones de AWS CodeStar además de otras políticas que puedan existir para ese tema. Para obtener más información, consulte Configuración de temas de Amazon SNS para notificaciones y Descripción del contenido y la seguridad de las notificaciones.

8. Para terminar de crear la regla, elija Enviar.

9. Debe suscribir a los usuarios al tema de Amazon SNS de la regla antes de que puedan recibir notificaciones. Para obtener más información, vea Suscribir usuarios a temas de Amazon SNS que son destinos. También puedes configurar la integración entre notificaciones y AWS Chatbot para enviar notificaciones a salas de chat de Amazon Chime. Para obtener más información, vea Configurar la integración entre notificaciones y AWS Chatbot.

Para crear una regla de notificación (AWS CLI)

1. En un terminal o símbolo del sistema, ejecute el comando create-notification rule para generar el esqueleto JSON:

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

   Puede asignar al archivo el nombre que desee. En este ejemplo, el archivo se denomina rule.json.

2. Abra el archivo JSON en un editor de texto sin formato y edítelo para incluir el recurso, los tipos de eventos y el destino que desea para la regla. En el ejemplo siguiente se muestra una regla de notificación denominada MyNotificationRule para un proyecto de compilación denominado MyBuildProject en una cuenta de AWS con el ID 123456789012. Las notificaciones se envían con el tipo de detalle completo a un tema de Amazon SNS denominado codestar-notifications-MyNotificationTopic cuando las compilaciones son correctas:

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

   Guarde el archivo.

3. Mediante el archivo que acaba de modificar, en el terminal o línea de comandos, vuelva a ejecutar el comando create-notification-rule para crear la regla de notificación:

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

4. Si se ejecuta correctamente, el comando devuelve el ARN de la regla de notificación, similar a lo siguiente:

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