でパイプラインに手動承認アクションを追加する CodePipeline

CodePipeline パイプラインのステージに承認アクションを追加し、パイプラインを停止して、誰かが手動でアクションを承認または拒否できるようにします。

注記

承認アクションをソースステージに追加することはできません。ソースステージには、ソースアクションのみ含めることができます。

承認アクションをレビューする準備が整ったときに、Amazon SNS を使用して通知を送信するには、まず次の前提条件を満たす必要があります。

• Amazon SNS リソースにアクセスするためのアクセス許可を CodePipeline サービスロールに付与します。詳細については、「サービスロールに Amazon SNS アクセス許可を付与する CodePipeline 」を参照してください。

• 承認アクションのステータスを更新できるようにするアクセス許可を組織の 1 人以上の IAM アイデンティティに付与します。詳細については、「で IAM ユーザーに承認許可を付与する CodePipeline」を参照してください。

この例では、新しい承認ステージを作成し、ステージにマニュアル承認アクションを追加します。マニュアル承認アクションを、他のアクションを含む既存のステージに追加することもできます。

手動承認アクションを CodePipeline パイプラインに追加する (コンソール）

CodePipeline コンソールを使用して、既存の CodePipelineパイプラインに承認アクションを追加できます。新しいパイプラインを作成するときに承認アクションを追加する場合は、 AWS CLI を使用する必要があります。

1. https://console.aws.amazon.com/codepipeline/ で CodePipeline コンソールを開きます。

2. [Name] で、パイプラインを選択します。

3. パイプライン詳細ページで、[編集] を選択します。

4. 承認アクションを新しいステージに追加する場合は、承認リクエストを追加するパイプラインのポイントで [+Add stage (+ ステージの追加)] を選択し、ステージの名前を入力します。[ステージの追加 (Add stage)] ページの [Stage name (ステージ名)] に、新しいステージ名を入力します。たとえば、新しいステージを追加し、Manual_Approval という名前を付けます。

   承認アクションを既存のステージに追加する場合は、[ステージの編集] を選択します。

5. 承認アクションを追加するステージで、[+ Add action group (アクショングループの追加)] を選択します。

6. [アクションの編集] ページで、次の作業を行います。

   1. [アクション名] に、アクションを識別する名前を入力します。

   2. [アクションプロバイダー] の、[承認] で、[手動承認l] を選択します。

   3. (オプション) [SNS トピックの ARN] で、承認アクションの通知を送るために使用するトピックの名前を選択します。

   4. (オプション) [URL for review] に、承認者が検討するページまたはアプリケーションの URL を入力します。承認者は、パイプラインのコンソールビューに含まれるリンクからこの URL にアクセスできます。

   5. (オプション) [コメント] に、レビュー者と共有するその他の情報を入力します。

   6. [保存] を選択します。

手動承認アクションをパイプラインに追加する CodePipeline (CLI)

CLI を使用して、承認アクションを既存のパイプラインに追加するか、パイプライン作成時に追加します。そのためには、作成中または編集中のステージで承認アクション (手動の承認タイプ) を追加します。

パイプラインの作成および編集に関する詳細は、「でパイプラインを作成する CodePipeline」および「でパイプラインを編集する CodePipeline」を参照してください。

承認アクションを含むパイプラインにステージを追加するには、パイプライン作成時または更新時に、次の例のように追加します。

注記

configuration セクションはオプションです。このセクションはファイルの一部であり、構造全体を示したものではありません。詳細については、「CodePipeline パイプライン構造リファレンス」を参照してください。

{
    "name": "MyApprovalStage",
    "actions": [
        {
            "name": "MyApprovalAction",
            "actionTypeId": {
                "category": "Approval",
                "owner": "AWS",
                "version": "1",
                "provider": "Manual"
            },
            "inputArtifacts": [],
            "outputArtifacts": [],
            "configuration": {
                "NotificationArn": "arn:aws:sns:us-east-2:80398EXAMPLE:MyApprovalTopic",
                "ExternalEntityLink": "http://example.com",
                "CustomData": "The latest changes include feedback from Bob."},
            "runOrder": 1
        }
    ]
}       

承認アクションが他のアクションを含むステージに存在する場合、このステージを含む JSON ファイルのセクションは、次の例のようになります。

注記

configuration セクションはオプションです。このセクションはファイルの一部であり、構造全体を示したものではありません。詳細については、「CodePipeline パイプライン構造リファレンス」を参照してください。

,
{
    "name": "Production",
    "actions": [
        {
            "inputArtifacts": [],
            "name": "MyApprovalAction",
            "actionTypeId": {
                "category": "Approval",
                "owner": "AWS",
                "version": "1",
                "provider": "Manual"
            },
            "outputArtifacts": [],
            "configuration": {
                "NotificationArn": "arn:aws:sns:us-east-2:80398EXAMPLE:MyApprovalTopic",
                "ExternalEntityLink": "http://example.com",
                "CustomData": "The latest changes include feedback from Bob."
            },
            "runOrder": 1
        },
        {
            "inputArtifacts": [
                {
                    "name": "MyApp"
                }
            ],
            "name": "MyDeploymentAction",
            "actionTypeId": {
                "category": "Deploy",
                "owner": "AWS",
                "version": "1",
                "provider": "CodeDeploy"
            },
            "outputArtifacts": [],
            "configuration": {
                "ApplicationName": "MyDemoApplication",
                "DeploymentGroupName": "MyProductionFleet"
            },
            "runOrder": 2
        }
    ]
}