알림 규칙 생성

알림 규칙을 사용하여 빌드 성공 및 실패와 같은 중요한 변경 사항이 발생할 경우 사용자에게 알릴 수 있습니다. 알림 규칙은 알림을 보내는 데 사용되는 이벤트와 Amazon SNS 주제를 모두 지정합니다. 자세한 내용은 알림이란 무엇입니까?를 참조하세요.

콘솔 또는 AWS CLI를 사용하여 AWS CodeBuild에 대한 알림 규칙을 생성할 수 있습니다.

알림 규칙을 생성하려면(콘솔)

1. AWS Management Console에 로그인한 후 https://console.aws.amazon.com/codebuild/에서 CodeBuild 콘솔을 엽니다.

2. 빌드, 빌드 프로젝트를 차례로 선택한 다음 알림을 추가할 빌드 프로젝트를 선택합니다.

3. 빌드 프로젝트 페이지에서 알림을 선택하고 Create notification rule(알림 규칙 생성)을 선택합니다. 빌드 프로젝트의 설정 페이지로 이동하여 Create notification rule(알림 규칙 생성)를 선택할 수도 있습니다.

4. 알림 이름에 규칙에 대한 이름을 입력합니다.

5. 알림에 포함된 Amazon EventBridge에 제공된 정보만 원하는 경우 세부 정보 유형에서 기본을 선택합니다. Amazon EventBridge에 제공된 정보와 CodeBuild 또는 알림 관리자에서 제공할 수 있는 정보를 포함하려는 경우 전체를 선택합니다.

   자세한 내용은 알림 내용 및 보안 이해를 참조하십시오.

6. Events that trigger notifications(알림을 트리거하는 이벤트)에서 알림을 보내고자 하는 이벤트를 선택합니다. 자세한 내용은 빌드 프로젝트의 알림 규칙 이벤트를 참조하십시오.

7. 대상에서 다음 중 하나를 수행합니다.

   • 알림과 함께 사용할 리소스를 이미 구성한 경우 Choose target type(대상 유형 선택)에서 AWS Chatbot(Slack) 또는 SNS 주제를 선택합니다. 대상 선택에서 클라이언트의 이름(AWS Chatbot에 구성된 Slack 클라이언트의 경우) 또는 Amazon SNS 주제의 Amazon 리소스 이름(ARN)(알림에 필요한 정책으로 이미 구성된 Amazon SNS 주제의 경우)을 선택합니다.

   • 알림과 함께 사용할 리소스를 구성하지 않은 경우 Create target(대상 생성)을 선택한 다음 SNS 주제를 선택합니다. codestar-notifications- 뒤에 주제 이름을 입력한 다음 생성을 선택합니다.

   참고

   • 알림 규칙을 만드는 과정에서 Amazon SNS 주제를 생성하면 알림 기능이 주제에 이벤트를 게시할 수 있도록 허용하는 정책이 적용됩니다. 알림 규칙에 대해 생성된 주제를 사용하면 이 리소스에 대한 알림을 받기를 원하는 사용자만 구독할 수 있습니다.

   • 알림 규칙 생성 중에는 AWS Chatbot 클라이언트를 생성할 수 없습니다. AWS Chatbot(Slack)을 선택하면 AWS Chatbot에서 클라이언트를 구성하도록 지시하는 버튼이 표시됩니다. 이 옵션을 선택하면 AWS Chatbot 콘솔이 열립니다. 자세한 내용은 알림과 AWS Chatbot 간의 통합 구성을 참조하십시오.

   • 기존 Amazon SNS 주제를 대상으로 사용하려면 해당 주제에 대해 존재할 수 있는 다른 정책 외에 AWS CodeStar Notifications에 필요한 정책을 추가해야 합니다. 자세한 내용은 알림에 대한 Amazon SNS 주제 구성과 알림 내용 및 보안 이해를 참조하십시오.

8. 규칙 생성을 완료하려면 제출을 선택합니다.

9. 사용자가 알림을 받으려면 먼저 규칙에 대한 Amazon SNS 주제를 사용자가 구독하도록 해야 합니다. 자세한 내용은 대상인 Amazon SNS 주제에 사용자 구독을 참조하세요. Amazon Chime 채팅룸에 알림을 보내도록 알림과 AWS Chatbot 간의 통합을 설정할 수도 있습니다. 자세한 내용은 알림과 AWS Chatbot 간의 통합 구성을 참조하십시오.

알림 규칙을 생성하려면(AWS CLI)

1. 터미널 또는 명령 프롬프트에서 create-notification rule 명령을 실행하여 JSON 스켈레톤을 생성합니다.

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

   원하는 대로 파일 이름을 지정할 수 있습니다. 이 예에서는 rule.json으로 파일 이름을 지정합니다.

2. 일반 텍스트 편집기에서 JSON 파일을 열고 규칙에 대해 원하는 리소스, 이벤트 유형 및 대상을 포함하도록 편집합니다. 다음 예는 ID가 123456789012인 AWS 계정의 MyBuildProject라는 리포지토리에 대한 MyNotificationRule이라는 알림 규칙을 보여 줍니다. 빌드가 성공적일 때 codestar-notifications-MyNotificationTopic이라는 Amazon SNS 주제에 전체 세부 정보 유형과 함께 알림이 전송됩니다.

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

   파일을 저장합니다.

3. 터미널 또는 명령줄에서 create-notification-rule 명령을 다시 실행하여 조금 전 편집한 파일을 사용해 알림 규칙을 생성합니다.

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

4. 성공한 경우 명령에서 다음과 유사한 알림 규칙의 ARN을 반환합니다.

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