Creación de una regla de notificación - AWS CodeDeploy

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

Creación de una regla de notificación

Puede utilizar reglas de notificación para notificar a los usuarios cuando hay cambios en las aplicaciones de implementación, como éxitos y errores de implementació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 CodeDeploy.

Para crear una regla de notificación (consola)

  1. Inicie sesión en la Consola de administración de AWS y abra la consola de CodeDeploy en https://console.aws.amazon.com/codedeploy/.

  2. Elija Application (Aplicación) y, a continuación, elija una aplicación donde desea agregar notificaciones.

  3. En la página de la aplicació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) para la aplicació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, elija Básico si desea que solo la información proporcionada en Amazon EventBridge se incluya en la notificación. Seleccione Completo si desea incluir la información proporcionada en Amazon EventBridge y otra información que CodeDeploy 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.

    Categoría Eventos

    Implementación

    Failed

    Realizado correctamente

    Started

  7. En Targets (Destinos), elija Create SNS topic (Crear tema SNS).

    nota

    Al crear el tema, se le aplica la política que permite a CodeDeploy publicar eventos en el tema. El uso de un tema creado específicamente para notificaciones de CodeDeploy también ayuda a garantizar que solo agregue usuarios a la lista de suscripciones para ese tema para el que desee ver notificaciones sobre esta aplicación de implementación.

    Después del prefijo codestar-notifications- escriba un nombre para el tema y, a continuación, elija Submit (Enviar).

    nota

    Si desea utilizar un tema de Amazon SNS existente en lugar de crear uno nuevo, en Targets (Destinos), elija su ARN. Asegúrese de que el tema tiene la directiva de acceso adecuada y de que la lista de suscriptores contiene salo aquellos usuarios a los que se permite ver información sobre la aplicación de implementación. Para obtener más información, consulte Configuración de temas existentes 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, consulte Suscribir usuarios a temas de Amazon SNS que son destinos. También puedes configurar la integración entre notificaciones y Amazon Q Developer en aplicaciones de chat para enviar notificaciones a salas de chat de Amazon Chime o a canales de Slack. Para obtener más información, consulte Configuración de la integración entre notificaciones y Amazon Q Developer en aplicaciones de chat.

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 ejemplo siguiente se muestra una regla de notificación denominada MyNotificationRule para una aplicación denominada MyDeploymentApplication 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 implementaciones se realizan correctamente:

    {
    "Name": "MyNotificationRule",
    "EventTypeIds": [
        "codedeploy-application-deployment-succeeded"
    ],
    "Resource": "arn:aws:codebuild:us-east-2:123456789012:MyDeploymentApplication",
    "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"
}