通知ルールの作成

通知ルールを使用すると、デプロイの成功や失敗など、デプロイアプリケーションに変更があった場合にユーザーに通知できます。通知ルールは、イベントと、通知の送信に使用される Amazon SNS トピックの両方を指定します。詳細については、「通知とは」を参照してください。

コンソールまたは を使用して AWS CLI 、通知ルールを作成できます AWS CodeDeploy。

通知ルールを作成するには (コンソール)

1. にサインイン AWS Management Console し、https://console.aws.amazon.com/codedeploy/://https://www.com で CodeDeploy コンソールを開きます。

2. [Application (アプリケーション)] を選択し、通知を追加するアプリケーションを選択します。

3. アプリケーションページで、[Notify (通知)]、[Create notification rule (通知ルールの作成)] の順に選択します。アプリケーションの [Settings (設定)] ページに移動し、[Create notification rule (通知ルールの作成)] を選択することもできます。

4. [通知名] に、ルールの名前を入力します。

5. Amazon EventBridge に提供された情報のみを通知に含める場合は、[Detail type (詳細タイプ)] で [Basic (基本)] を選択します。Amazon EventBridge に提供される情報に加えて、CodeDeploy または通知マネージャから提供される場合がある情報も含める場合は、[Full (完全)] を選択します。

   詳細については、「通知の内容とセキュリティについて」を参照してください。

6. [Events that trigger notifications (通知をトリガーするイベント)] で、通知を送信するイベントを選択します。

   カテゴリ	イベント
   デプロイ	失敗 成功 起動済み

7. [ターゲット] で、[SNS トピックの作成] を選択します。

   注記

   トピックを作成すると、トピックへのイベントの発行を CodeDeploy に許可するポリシーが適用されます。CodeDeploy 通知専用に作成されたトピックを使用すると、このデプロイアプリケーションに関する通知を表示するトピックのサブスクリプションリストにのみユーザーを追加することもできます。

   [codestar-notifications-] プレフィックスの後にトピックの名前を入力し、[送信] を選択します。

   注記

   新しいトピックを作成する代わりに既存の Amazon SNS トピックを使用する場合は、[Targets (ターゲット)] でその ARN を選択します。トピックに適切なアクセスポリシーが設定されていること、およびサブスクライバーリストにデプロイアプリケーションに関する情報の表示を許可されたユーザーのみが含まれていることを確認します。詳細については、「通知用の Amazon SNS トピックを設定する」および「通知の内容とセキュリティについて理解する」を参照してください。

8. ルールの作成を終了するには、[Submit (送信)] を選択します。

9. 通知を受け取るには、そのルールの Amazon SNS トピックにユーザーをサブスクライブする必要があります。詳細については、「ターゲットである Amazon SNS トピックへのユーザーのサブスクライブ」を参照してください。チャットアプリケーションで通知と Amazon Q Developer の統合を設定して、Amazon Chime チャットルームまたは Slack チャネルに通知を送信することもできます。詳細については、「チャットアプリケーションで通知と Amazon Q Developer の統合を設定する」を参照してください。

通知ルールを作成するには (AWS CLI)

1. ターミナルまたはコマンドプロンプトで、create-notification rule コマンドを実行して、JSON スケルトンを生成します。

   aws codestar-notifications create-notification-rule --generate-cli-skeleton > rule.json

   ファイルには任意の名前を付けることができます。この例では、ファイルの名前を rule.json とします。

2. プレーンテキストエディタで JSON ファイルを開き、これを編集してルールに必要なリソース、イベントタイプ、Amazon SNS ターゲットを含めます。次の例は、ID MyNotificationRuleが 123456789012 AWS アカウントで MyDeploymentApplication という名前のアプリケーションの という名前の通知ルールを示しています。デプロイが成功したとき、通知は、完全な詳細タイプで codestar-通知-MyNotificationTopic という名で Amazon SNS トピックに送信されます：

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

   ファイルを保存します。

3. 先ほど編集したファイルを使用して、ターミナルまたはコマンドラインで、create-notification-rule コマンドを再度実行し、通知ルールを作成します。

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

4. 成功すると、コマンドは次のような通知ルールの ARN を返します。

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