Creación de una regla de notificación

Puede utilizar reglas de notificación para notificar a los usuarios los cambios importantes, como cuando una canalización comienza la ejecució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 usar la consola o la AWS CLI para crear reglas de notificación para AWS CodePipeline.

Para crear una regla de notificación (consola)

1. Inicie sesión en la CodePipeline consola AWS Management Console y ábrala en https://console.aws.amazon.com/codepipeline/.

2. Elija Canalizaciones, y, a continuación, elija una canalización en la que desee agregar notificaciones.

3. En la página de canalización, elija Notify (Notificar) y, a continuación, elija Create notification rule (Crear regla de notificación). También puede ir a la página Settings (Configuración) de la canalización y elegir Create notification rule (Crear regla de notificación).

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

5. En Tipo de detalle, selecciona Básico si quieres que solo se EventBridge incluya en la notificación la información proporcionada a Amazon. Selecciona Completa si deseas incluir la información proporcionada a Amazon EventBridge y la información que pueda proporcionar el administrador de notificaciones CodePipeline o el administrador de notificaciones.

   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 para reglas de notificación en canalizaciones.

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 Chatbot Slack o Tema de SNS. En Choose target, elige el nombre del cliente (para un cliente de Slack configurado en AWS Chatbot) o el nombre de recurso de Amazon (ARN) del tema Amazon SNS (para los temas de Amazon SNS ya configurados con la política requerida 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 puede crear un AWS Chatbot cliente como parte de la creación de una regla de notificación. Si eliges AWS Chatbot (Slack), verás un botón que te indicará que configures un cliente. AWS Chatbot Si eliges esa opción, se abre la AWS Chatbot consola. Para obtener más información, consulte Configurar integraciones 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 puede configurar la integración entre las notificaciones y enviar notificaciones AWS Chatbot a las salas de chat de Amazon Chime o a los canales de Slack. Para obtener más información, consulte 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 codestar-notifications 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 siguiente ejemplo, se muestra una regla de notificación con el nombre MyNotificationRule de una canalización nombrada MyDemoPipelineen una AWS cuenta con el identificador 123456789012. Las notificaciones se envían con todos los detalles a un tema de Amazon SNS denominado codestar-notifications, cuando comienzan las ejecuciones del proceso: MyNotificationTopic

   {
       "Name": "MyNotificationRule",
       "EventTypeIds": [
           "codepipeline-pipeline-pipeline-execution-started"
       ],
       "Resource": "arn:aws:codebuild:us-east-2:123456789012:MyDemoPipeline",
       "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 codestar-notifications 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"
   }