기계 번역으로 제공되는 번역입니다. 제공된 번역과 원본 영어의 내용이 상충하는 경우에는 영어 버전이 우선합니다.
알림 관련 개념
개념 및 용어를 이해하면 알림 설정 및 사용이 더 쉬워집니다. 알림을 사용할 때 알아야 할 몇 가지 개념은 다음과 같습니다.
주제
알림
알림은 사용자 및 개발자가 사용하는 리소스에서 발생하는 이벤트에 관한 정보가 포함된 메시지입니다. 알림을 설정하면 생성한 알림 규칙에 따라 빌드 프로젝트, 리포지토리, 배포 애플리케이션 또는 파이프라인과 같은 리소스 사용자가 지정한 이벤트 유형에 관한 이메일을 수신합니다.
AWS CodeCommit에 대한 알림에는 세션 태그의 사용을 통해 표시 이름이나 이메일 주소와 같은 사용자 자격 증명 정보가 포함될 수 있습니다. CodeCommit에서는 세션 태그의 사용을 지원합니다. 세션 태그는 IAM 역할을 맡거나, 임시 자격 증명을 사용하거나, AWS Security Token Service(AWS STS)에서 사용자를 연동할 때 전달하는 키-값 페어 속성입니다. IAM 사용자에 태그를 연결할 수도 있습니다. CodeCommit은 해당 태그가 있는 경우 displayName
및 emailAddress
에 대한 값을 알림 내용에 포함합니다. 자세한 내용은 태그를 사용하여 CodeCommit에 추가 자격 증명 정보 제공을 참조하세요.
중요
알림에는 빌드 상태, 배포 상태, 의견을 보유한 코드 라인 및 파이프라인 승인과 같은 프로젝트별 정보가 포함됩니다. 새 기능이 추가되면 알림 내용이 변경될 수 있습니다. 보안 모범 사례로 알림 규칙 및 Amazon SNS 주제 구독자의 대상을 정기적으로 검토해야 합니다. 자세한 내용은 알림 콘텐츠 및 보안 이해 섹션을 참조하세요.
알림 규칙
알림 규칙은 알림이 발송되는 시기 및 위치를 지정하도록 생성한 AWS 리소스입니다. 이는 다음을 정의합니다.
-
알림이 생성되는 조건. 이러한 조건은 선택한 이벤트를 기반으로 하며, 리소스 유형에 따라 다릅니다. 지원되는 리소스 유형으로는 AWS CodeBuild의 빌드 프로젝트, AWS CodeDeploy의 배포 애플리케이션, AWS CodePipeline의 파이프라인 및 AWS CodeCommit의 리포지토리가 있습니다.
-
알림이 발송되는 대상. 알림 규칙에 대해 최대 10개의 대상을 지정할 수 있습니다.
알림 규칙의 범위는 개별 빌드 프로젝트, 배포 애플리케이션, 파이프라인 및 리포지토리입니다. 알림 규칙에는 사용자가 정의한 친숙한 이름 및 Amazon 리소스 이름(ARN)이 둘 다 있습니다. 알림 규칙은 리소스가 존재하는 AWS 리전에서만 생성되어야 합니다. 예를 들어 미국 동부(오하이오) 리전에서 프로젝트를 빌드하는 경우 알림 규칙도 미국 동부(오하이오) 리전에서 생성해야 합니다.
리소스당 최대 10개의 알림 규칙을 정의할 수 있습니다.
이벤트
이벤트는 모니터링하고자 하는 리소스의 상태 변경입니다. 각 리소스에는 선택할 수 있는 이벤트 유형 목록이 있습니다. 리소스에 알림 규칙을 설정할 때 알림이 전송되도록 하는 이벤트를 지정합니다. 예를 들어 CodeCommit에서 리포지토리에 대한 알림을 설정하고 [풀 요청(Pull request)]과 [브랜치 및 태그(Branches and tags)] 모두에서 [생성됨(Created)]을 선택하면 해당 리포지토리의 사용자가 풀 요청, 브랜치 또는 Git 태그를 생성할 때마다 알림이 전송됩니다.
세부 정보 유형
알림 규칙을 생성할 때 알림에 포함되는 세부 정보 또는 세부 유형 수준을 선택할 수 있습니다(전체 또는 기본). 전체 설정(기본값)에는 특정 이벤트에 대해 서비스에서 제공하는 개선된 정보를 비롯하여 알림의 이벤트에 사용할 수 있는 모든 정보가 포함됩니다. 기본 설정에는 사용 가능한 정보의 하위 집합만 포함됩니다.
다음 표에서는 특정 이벤트 유형에 사용할 수 있는 개선된 정보를 나열하고 세부 유형 간의 차이점을 설명합니다.
서비스 | 이벤트 | 전체에 포함되는 항목 | 기본에 포함되지 않는 항목 |
---|---|---|---|
CodeCommit |
커밋에 대한 의견 풀 요청에 대한 의견 |
모든 이벤트 세부 정보 및 의견의 내용(답글 또는 의견 스레드 포함). 또한 줄 번호와 의견이 만들어진 코드 줄을 포함합니다. |
의견의 내용. 행 번호, 코드 줄 또는 주석 스레드 |
CodeCommit |
풀 요청이 생성됨 |
대상 분기와 관련하여 풀 요청에서 추가, 수정 또는 삭제된 모든 이벤트 세부 정보 및 파일 수입니다. |
풀 요청 원본 분기가 파일을 추가, 수정 또는 삭제했는지 여부에 대한 파일 목록이나 세부 정보는 없습니다. |
CodePipeline |
수동 승인 필요 |
모든 이벤트 세부 정보 및 사용자 지정 데이터(구성된 경우). 알림에는 파이프라인의 필수 승인에 대한 링크도 포함됩니다. |
사용자 지정 데이터 또는 링크가 없습니다. |
CodePipeline |
작업 실행 실패 파이프라인 실행 실패 스테이지 실행 실패 |
모든 이벤트 세부 정보 및 실패에 대한 오류 메시지의 내용입니다. |
오류 메시지 내용이 없습니다. |
대상
대상은 알림 규칙으로부터 알림을 수신하는 위치입니다. 허용되는 대상 유형은 Slack 또는 Microsoft Teams 채널에 대해 구성된 Amazon SNS 주제 및 AWS Chatbot 클라이언트입니다. 대상을 구독하는 모든 사용자는 알림 규칙에서 지정한 이벤트에 관해 알림을 수신합니다.
알림 범위를 확장하고자 하는 경우 알림이 Amazon Chime 채팅룸으로 발송되도록 알림과 AWS Chatbot 간의 통합을 수동으로 구성할 수 있습니다. 그런 다음 해당 AWS Chatbot 클라이언트에 대해 구성된 Amazon SNS 주제를 알림 규칙의 대상으로 선택할 수 있습니다. 자세한 내용은 AWS Chatbot 및 Amazon Chime과 알림을 통합하려면 섹션을 참조하세요.
AWS Chatbot 클라이언트를 대상으로 사용하는 경우 먼저 AWS Chatbot에서 해당 클라이언트를 생성해야 합니다. AWS Chatbot 클라이언트를 알림 규칙의 대상으로 선택하면 Slack 또는 Microsoft Teams 채널로 알림을 보내는 데 필요한 모든 정책이 포함된 Amazon SNS 주제가 해당 AWS Chatbot 클라이언트에 대해 구성됩니다. AWS Chatbot 클라이언트에 대한 기존 Amazon SNS 주제를 구성할 필요가 없습니다.
알림 규칙 생성 중 Amazon SNS 주제를 대상으로 생성하도록 선택할 수 있습니다(권장). 알림 규칙과 동일한 AWS 리전의 기존 Amazon SNS 주제를 선택할 수도 있지만 필요한 정책으로 구성해야 합니다. 대상에 사용하는 Amazon SNS 주제는 AWS 계정에 있어야 합니다. 또한 알림 규칙 및 규칙이 생성된 AWS 리소스와 동일한 AWS 리전에 있어야 합니다.
예를 들어 미국 동부(오하이오) 리전에서 리포지토리에 대한 알림 규칙을 생성한 경우 Amazon SNS 주제 또한 해당 리전에 존재해야 합니다. 알림 규칙을 만드는 과정에서 Amazon SNS 주제를 생성하는 경우 주제는 주제에 이벤트를 게시할 수 있도록 허용하는 데 필요한 정책으로 구성됩니다. 이는 대상 및 알림 규칙 작업에 가장 적합한 방법입니다. 이미 존재하는 주제를 사용하거나 수동으로 만들도록 선택한 경우 필요한 권한으로 주제를 구성해야 사용자가 알림을 받을 수 있습니다. 자세한 내용은 알림에 대한 Amazon SNS 주제 구성 섹션을 참조하세요.
참고
새 항목을 생성하는 대신 기존 Amazon SNS 항목을 사용하려면 [대상(Targets)]에서 해당 ARN을 선택합니다. 주제에 적절한 액세스 정책이 있는지 여부와 구독자 목록에 리소스에 대한 정보를 볼 수 있는 사용자만 포함되어 있는지를 확인합니다. Amazon SNS 주제가 2019년 11월 5일 이전에 CodeCommit 알림에 사용된 주제인 경우 CodeCommit이 AWS CodeStar Notifications에 필요한 권한과 다른 권한을 포함하는 주제를 게시하도록 허용하는 정책이 포함됩니다. 이러한 주제는 사용하지 않는 것이 좋습니다. 해당 환경에 대해 생성된 정책을 사용하려면 이미 존재하는 정책 외에 AWS CodeStar Notifications에 대한 필수 정책을 추가해야 합니다. 자세한 정보는 알림에 대한 Amazon SNS 주제 구성 및 알림 콘텐츠 및 보안 이해 섹션을 참조하세요.
알림 및 AWS CodeStar Notifications
개발자 도구 콘솔의 기능인 알림에는 자체적인 API인 AWS CodeStar Notifications가 있습니다. 또한 자체 AWS 리소스 유형(알림 규칙), 권한 및 이벤트도 있습니다. 알림 규칙에 대한 이벤트는 AWS CloudTrail에 기록됩니다. API 작업은 IAM 정책을 통해 허용되거나 거부될 수 있습니다.
리포지토리의 알림 규칙에 대한 이벤트
범주 | 이벤트 | 이벤트 ID |
---|---|---|
설명 |
커밋 시 풀 요청 시 |
|
승인 |
상태 변경 규칙 재정의 |
|
풀 요청 |
생성 완료 소스 업데이트 상태 변경 병합 |
|
브랜치 및 태그 |
생성 완료 Deleted Updated |
codecommit-repository-branches-and-tags-updated |
빌드 프로젝트의 알림 규칙에 대한 이벤트
범주 | 이벤트 | 이벤트 ID |
---|---|---|
빌드 상태 |
실패함 성공 진행 중 중지됨 |
|
빌드 단계 |
결함 성공 |
|
배포 애플리케이션의 알림 규칙 이벤트
범주 | 이벤트 | 이벤트 ID |
---|---|---|
배포 |
실패함 성공 시작됨 |
codedeploy-application-deployment-started |
파이프라인의 알림 규칙에 대한 이벤트
범주 | 이벤트 | 이벤트 ID |
---|---|---|
작업 실행 |
성공 실패함 취소됨 시작됨 |
|
단계 실행 |
시작됨 성공 재개 취소됨 실패함 |
|
파이프라인 실행 |
실패함 취소됨 시작됨 재개 성공 대체됨 |
|
수동 승인 |
실패함 필요 성공 |
codepipeline-pipeline-manual-approval-succeeded |