CodePipeline の承認アクションを管理する

AWS CodePipeline では、パイプラインのステージに承認アクションを追加した個所でパイプラインの実行を停止することで、必要な AWS Identity and Access Management アクセス許可を持つユーザーがアクションを承認または拒否できます。

アクションが承認されると、パイプラインの実行が再開されます。アクションが拒否されているか、パイプラインの到達および停止のアクションが 7 日間以内に承認または拒否されない場合は、アクションが失敗した時と同じ結果になり、パイプラインの実行は継続されません。

次の理由で手動承認を使用する場合があります。

• リビジョンがパイプラインの次のステージに移行される前に、コードレビューの実施または管理レビューの変更を行う場合

• リリース前に、最新バージョンのアプリケーションで手動の品質保証を実行するか、ビルドアーティファクトの完全性を確認する場合

• 企業のウェブサイトに公開する前に新規テキストまたは更新済みのテキストをレビューしてもらう場合

CodePipeline でのマニュアルの承認アクションに関する設定オプション

CodePipeline には、承認アクションに関して承認者に通知することができる 3 つの設定オプションがあります。

承認通知の発行 パイプラインがアクションで停止されると、Amazon Simple Notification Service のトピックにメッセージが発行されるように、承認アクションを設定できます。Amazon SNS は、トピックにサブスクライブされた各エンドポイントにメッセージを送信します。承認アクションを含むパイプラインと同じ AWS リージョンで作成されたトピックを使用する必要があります。トピックを作成する際には、MyFirstPipeline-us-east-2-approval などの形式で、目的を識別しやすい名前を付けることをお勧めします。

承認通知を Amazon SNS トピックに発行する場合は、E メールか SMS の受信者、SQS キュー、HTTP/HTTPS エンドポイント、または Amazon SNS を用いて呼び出す AWS Lambda 関数などの形式から選択することができます。Amazon SNS トピックの通知の詳細については、以下のトピックを参照してください。

• Amazon Simple Notification Service

• Amazon SNS トピックを作成します

• Amazon SQS キューへの Amazon SNS メッセージの送信

• Amazon SNS トピックへのキューのサブスクライブ

• HTTP/HTTPS エンドポイントへの Amazon SNS メッセージの送信

• Amazon SNS 通知を用いた Lambda 関数の呼び出し

承認アクションの通知で生成される JSON データの構造については、「CodePipeline でのマニュアルの承認通知の JSON データ形式」を参照してください。

レビューする URL の指定 承認アクションの設定の一部として、レビューする URL を指定することができます。この URL は、承認者がテストするウェブアプリケーションか、承認リクエストに関する詳細を含むページへのリンクです。また、URL には、Amazon SNS トピックに対して発行される通知が含まれます。承認者は、コンソールまたは CLI を使用して表示することができます。

承認者に対するコメントの入力 承認アクションを作成する場合、コメントを追加して、通知の受取者、またはコンソールか CLI レスポンスのアクションを確認するユーザーに表示することもできます。

設定オプション不要 これらの 3 つのオプションのいずれも設定しないように選択することもできます。たとえば、アクションがレビューできる状態になったことや、アクションを承認するまでパイプラインを停止することを直接通知する場合などに、これらの設定は不要です。

CodePipeline での承認アクションのセットアップおよびワークフローの概要

手動の承認の設定および使用に関する概要は次のとおりです。

1. 承認アクションの承認または拒否に必要な IAM のアクセス許可を組織内の IAM ロールに 1 つ以上付与します。

2. (オプション) Amazon SNS 通知を使用している場合、CodePipeline オペレーションで使用しているサービスロールには、Amazon SNS リソースにアクセスするためのアクセス許可が含まれます。

3. (オプション) Amazon SNS 通知を使用している場合、Amazon SNS のトピックを作成し、1 人以上の受信者または 1 つ以上のエンドポイントを追加します。

4. AWS CLI を使用してパイプラインを作成するか、CLI またはコンソールを使用してパイプラインを作成したら、承認アクションをパイプラインのステージに追加します。

   通知を使用している場合は、アクションの設定に Amazon SNS トピックの Amazon リソースネーム (ARN) を含みます。(ARN は Amazon リソース独自の識別子です。Amazon SNS トピックの ARN は、arn:aws:sns:us-east-2:80398EXAMPLE:MyApprovalTopic のような構造になっています。詳細については、Amazon Web Services 全般のリファレンス の「Amazon リソースネーム (ARN) と AWS のサービス 名前空間」を参照してください。)

5. 承認アクションに達すると、パイプラインは停止します。Amazon SNS トピックの ARN がアクション設定に含まれている場合、通知は Amazon SNS トピックに発行され、メッセージは、コンソールの承認アクションをレビューするリンクと合わせて、トピックの受信者またはサブスクライブされたエンドポイントに送信されます。

6. 承認者は、必要に応じて、ターゲット URL およびコメントを確認します。

7. 承認者は、コンソール、CLI、SDK を使用して、概要コメントを確認し、次のようなレスポンスを送信します。

   • 承認済み: パイプラインの実行が再開されます。

   • 拒否: ステージステータスが「失敗」に変更され、パイプラインの実行は再開されません。

   7 日以内にレスポンスが送信されない場合、アクションは「失敗」とマークされます。