Creación de una regla de notificación

Puede utilizar la consola de herramientas para desarrolladores o la AWS CLI para crear reglas de notificación. Puede crear un tema de Amazon SNS para utilizarlo como destino de una regla de notificación durante la creación de la regla. Si desea utilizar un cliente de AWS Chatbot como destino, debe crearlo antes de crear la regla. Para obtener más información, consulte Configuración de un cliente de AWS Chatbot para un canal de Slack.

Para crear una regla de notificación (consola)

1. Abra la consola de las herramientas para desarrolladores de AWS en https://console.aws.amazon.com/codesuite/settings/notifications.

2. Utilice la barra de navegación para desplazarse hasta el recurso.

   • En CodeBuild, elija Build (Compilar). Luego, elija Build projects (Compilar proyectos) y elija un proyecto de compilación.

   • En CodeCommit, elija Source (Fuente), Luego, elija Repositories (Repositorios) y elija un repositorio.

   • En CodeDeploy, elija Applications (Aplicaciones) y elija una aplicación.

   • En CodePipeline, elija Pipeline (Canalización). Luego, elija Pipelines (Canalizaciones) y elija una canalización.

3. En la página de recursos, 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) del recurso, ir a Notifications (Notificaciones) o Notification rules (Reglas de notificación) y elegir Create notification rule (Crear regla de notificación).

4. En Notification name (Nombre de la notificación), introduzca un nombre para la regla.

5. En Detail type (Tipo de detalle), elija Basic (Básico) si desea que solo la información proporcionada en Amazon EventBridge se incluya en la notificación. Elija Full (Completo) si desea incluir la información proporcionada en Amazon EventBridge y otra información que el servicio de recurso 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 Events that trigger notifications (Eventos que activan notificaciones), seleccione los eventos para los que desea enviar notificaciones. Para obtener información sobre los tipos de evento de un recurso, consulte lo siguiente:

   • CodeBuild: Eventos de reglas de notificación en proyectos de compilación

   • CodeCommit: Eventos de reglas de notificación en repositorios

   • CodeDeploy: Eventos de reglas de notificación en aplicaciones de implementación

   • CodePipeline: Eventos de reglas de notificación en canalizaciones

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

   • Si ya ha configurado un recurso para utilizarlo con notificaciones, en Elegir tipo de destino, elija AWSChatbot (Slack), AWS Chatbot (Microsoft Teams) o Tema de SNS. En Elegir destino, elija el nombre del cliente (para un cliente de Slack o Microsoft Teams 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 Create target (Crear destino) y, a continuación, elija SNS topic (Tema de SNS). Indique el nombre del tema después de codestar-notifications- y, a continuación, elija Create (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) o AWS Chatbot (Microsoft Teams), aparecerá un botón que lo llevará a configurar un cliente en AWS Chatbot. Mediante la elección de esa opción, se abrirá la consola de AWS Chatbot. Para obtener más información, consulte Configuración de un cliente de AWS Chatbot para un canal de Slack.

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

8. Elija Submit (Enviar) y, a continuación, revise la regla de notificación.

   nota

   Los usuarios deben suscribirse al tema de Amazon SNS que usted haya especificado como destino de la regla y confirmar su suscripción antes de recibir las notificaciones. Para obtener más información, consulte Para suscribir a los usuarios a un tema de Amazon SNS utilizado para las notificaciones.

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 de Amazon SNS que desea para la regla.

   En el siguiente ejemplo, se muestra una regla de notificación denominada MyNotificationRule para un repositorio denominado MyDemoRepo en una cuenta de AWS con el ID 123456789012. Las notificaciones con el tipo de detalle completo se envían a un tema de Amazon SNS denominado MyNotificationTopic cuando se crean las ramas y las etiquetas.

   {
       "Name": "MyNotificationRule",
       "EventTypeIds": [
           "codecommit-repository-branches-and-tags-created"
       ],
       "Resource": "arn:aws:codecommit:us-east-1:123456789012:MyDemoRepo",
       "Targets": [
           {
               "TargetType": "SNS",
               "TargetAddress": "arn:aws:sns:us-east-1:123456789012: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"
   }

Para mostrar los tipos de eventos de las reglas de notificación (AWS CLI)

1. Ejecute el comando list-event-types en un terminal o en la línea de comandos. Puede utilizar la opción --filters para delimitar los resultados a un tipo de recurso específico u otro atributo. Por ejemplo, lo siguiente devuelve una lista de tipos de eventos para las aplicaciones de CodeDeploy.

   aws codestar-notifications list-event-types --filters Name=SERVICE_NAME,Value=CodeDeploy

2. El resultado de este comando debería ser similar al siguiente.

   {
       "EventTypes": [
           {
               "EventTypeId": "codedeploy-application-deployment-succeeded",
               "ServiceName": "CodeDeploy",
               "EventTypeName": "Deployment: Succeeded",
               "ResourceType": "Application"
           },
           {
               "EventTypeId": "codedeploy-application-deployment-failed",
               "ServiceName": "CodeDeploy",
               "EventTypeName": "Deployment: Failed",
               "ResourceType": "Application"
           },
           {
               "EventTypeId": "codedeploy-application-deployment-started",
               "ServiceName": "CodeDeploy",
               "EventTypeName": "Deployment: Started",
               "ResourceType": "Application"
           }
       ]
   }

Para añadir una etiqueta a una regla de notificación (AWS CLI)

1. Ejecute el comando tag-resource en un terminal o en la línea de comandos. Por ejemplo, utilice el siguiente comando para agregar un par de clave-valor de etiqueta que tenga el nombre Team y el valor Li_Juan.

   aws codestar-notifications tag-resource --arn arn:aws:codestar-notifications:us-east-1:123456789012:notificationrule/fe1efd35-EXAMPLE --tags Team=Li_Juan

2. El resultado de este comando debería ser similar al siguiente.

   {
       "Tags": {
           "Team": "Li_Juan"
       }
   }