알림 규칙 생성

개발자 도구 콘솔을 사용하거나 AWS CLI를 사용하여 알림 규칙을 생성할 수 있습니다. 규칙을 생성하는 중 알림 규칙의 대상으로 사용할 Amazon SNS 주제를 생성할 수 있습니다. AWS Chatbot 클라이언트를 대상으로 사용하려면 규칙을 만들기 전에 해당 클라이언트를 만들어야 합니다. 자세한 내용은 Slack 채널에 대한 AWS Chatbot 클라이언트 구성 섹션을 참조하세요.

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

1. https://console.aws.amazon.com/codesuite/settings/notifications에서 AWS 개발자 도구 콘솔을 엽니다.

2. 탐색 모음을 사용하여 리소스로 이동합니다.

   • CodeBuild의 경우 [빌드(Build)]를 선택하고, [빌드 프로젝트(Build projects)]를 선택한 다음 빌드 프로젝트를 선택합니다.

   • CodeCommit의 경우 [소스(Source)]를 선택하고, [리포지토리(Repositories)]를 선택한 다음 리포지토리를 선택합니다.

   • CodeDeploy의 경우 [애플리케이션(Applications)]을 선택하고 애플리케이션을 선택합니다.

   • CodePipeline의 경우 [파이프라인(Pipeline)]을 선택하고, [파이프라인(Pipelines)]을 선택한 다음 파이프라인을 선택합니다.

3. 리소스 페이지에서 Notify(알림)를 선택하고 Create notification rule(알림 규칙 생성)을 선택합니다. 리소스에 대한 설정 페이지로 이동하고, 알림 또는 Notification rules(알림 규칙)로 이동한 다음 Create notification rule(알림 규칙 생성)을 선택할 수도 있습니다.

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

5. 알림에 포함된 Amazon EventBridge에 제공된 정보만 원하는 경우 [세부 정보 유형(Detail type)]에서 [기본(Basic)]을 선택합니다. Amazon EventBridge에 제공된 정보와 리소스 서비스 또는 알림 관리자가 제공할 수 있는 정보를 포함하려는 경우 [전체(Full)]를 선택합니다.

   자세한 내용은 알림 콘텐츠 및 보안 이해 섹션을 참조하세요.

6. Events that trigger notifications(알림을 트리거하는 이벤트)에서 알림을 보내고자 하는 이벤트를 선택합니다. 리소스에 대한 이벤트 유형은 다음을 참조하십시오.

   • CodeBuild: 빌드 프로젝트의 알림 규칙에 대한 이벤트

   • CodeCommit: 리포지토리의 알림 규칙에 대한 이벤트

   • CodeDeploy: 배포 애플리케이션의 알림 규칙 이벤트

   • CodePipeline: 파이프라인의 알림 규칙에 대한 이벤트

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

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

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

   참고

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

   • 알림 규칙 생성 중에는 AWS Chatbot 클라이언트를 생성할 수 없습니다. AWS Chatbot(Slack) 또는 AWS Chatbot(Microsoft Teams)을 선택하면 AWS Chatbot에서 클라이언트를 구성하도록 지시하는 버튼이 표시됩니다. 이 옵션을 선택하면 AWS Chatbot 콘솔이 열립니다. 자세한 내용은 Slack 채널에 대한 AWS Chatbot 클라이언트 구성 섹션을 참조하세요.

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

8. 제출을 선택한 다음 알림 규칙을 검토합니다.

   참고

   사용자가 알림을 받으려면 규칙의 대상으로 지정한 Amazon SNS 주제를 구독하고 구독을 확인해야 합니다. 자세한 내용은 알림에 사용되는 Amazon SNS 주제에 대해 사용자를 구독하려면 섹션을 참조하세요.

알림 규칙을 생성하려면(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가 123456789012인 AWS 계정의 MyDemoRepo라는 리포지토리에 대한 MyNotificationRule이라는 알림 규칙을 보여줍니다. 전체 세부 정보 유형의 알림은 브랜치 및 태그가 생성될 때 MyNotificationTopic이라는 Amazon SNS 주제로 전송됩니다.

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

   파일을 저장합니다.

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

알림 규칙의 이벤트 유형을 나열하려면(AWS CLI)

1. 터미널 또는 명령 프롬프트에서 list-event-types 명령을 실행합니다. --filters 옵션을 사용하여 응답을 특정 리소스 유형이나 다른 속성으로 제한할 수 있습니다. 예를 들어, 다음은 CodeDeploy 애플리케이션의 이벤트 유형 목록을 반환합니다.

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

2. 다음과 비슷한 출력이 생성됩니다.

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

알림 규칙에 태그를 추가하려면(AWS CLI)

1. 터미널 또는 명령 프롬프트에서 tag-resource 명령을 실행합니다. 예를 들어 다음 명령을 사용하여 Team이라는 이름과 Li_Juan 값이 있는 태그 키-값 페어를 추가합니다.

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

2. 다음과 비슷한 출력이 생성됩니다.

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