でカスタムアクションを作成して追加する CodePipeline

を使用してカスタムアクションを作成するには AWS CLI

1. テキストエディタを開き、アクションカテゴリ、アクションプロバイダー、カスタムアクションに必要な設定を含むカスタムアクション用のJSONファイルを作成します。例えば、1 つのプロパティのみを必要とするカスタムビルドアクションを作成するには、JSONファイルは次のようになります。

   {
       "category": "Build",
       "provider": "My-Build-Provider-Name",
       "version": "1",
       "settings": {
           "entityUrlTemplate": "https://my-build-instance/job/{Config:ProjectName}/",
           "executionUrlTemplate": "https://my-build-instance/job/{Config:ProjectName}/lastSuccessfulBuild/{ExternalExecutionId}/"
       },
       "configurationProperties": [{
           "name": "ProjectName",
           "required": true,
           "key": true,
           "secret": false,
           "queryable": false,
           "description": "The name of the build project must be provided when this action is added to the pipeline.",
           "type": "String"
       }],
       "inputArtifactDetails": {
           "maximumCount": integer,
           "minimumCount": integer
       },
       "outputArtifactDetails": {
           "maximumCount": integer,
           "minimumCount": integer
       },
       "tags": [{
         "key": "Project",
         "value": "ProjectA"
       }]
   }

   この例では、カスタムアクションで Project タグキーと ProjectA 値を含めることで、カスタムアクションにタグ付けを追加します。でのリソースのタグ付けの詳細については CodePipeline、「」を参照してくださいリソースのタグ付け。

   JSON ファイルには、 entityUrlTemplateという 2 つのプロパティが含まれていますexecutionUrlTemplate。テンプレート内のカスタムアクションの設定プロパティで名前を参照するには、設定プロパティが必須であり、シークレットでない限り{Config:name}、 の形式URLに従います。例えば、上記のサンプルでは、entityUrlTemplate値は設定プロパティを参照します。ProjectName.

   • entityUrlTemplate: アクションのサービスプロバイダーに関する情報を提供する静的リンク。この例では、ビルドシステムには、各ビルドプロジェクトへの静的リンクが含まれます。リンク形式は、ビルドプロバイダー (または、テストなど別のアクションタイプを作成する場合はその他のサービスプロバイダー) に応じて変わります。このリンク形式を指定し、カスタムアクションが追加されたときに、ユーザーはこのリンクを選択してブラウザを開き、ビルドプロジェクト (またはテスト環境) の詳細を提供するウェブサイト上のページに移動できるようにする必要があります。

   • executionUrlTemplate: アクションの現在の実行または最新の実行に関する情報で更新される動的リンク。カスタムジョブワーカーがジョブのステータス (成功、失敗、進行中など) を更新するときに、リンクを完了するために使用される externalExecutionId も提供されます。このリンクを使用して、アクションの実行に関する詳細を提供できます。

   例えば、パイプラインでアクションを表示すると、次の 2 つのリンクが表示されます。

   

   この静的リンクは、カスタムアクションを追加し、entityUrlTemplate でアドレスを指した後で表示されます (カスタムアクションを作成するときに指定します)。

   この動的なリンクは、アクションを実行し、executionUrlTemplate でアドレスを指すたびに更新されます (カスタムアクションを作成するときに指定します)。

   これらのリンクタイプ、RevisionURLTemplateおよび の詳細については、 CodePipeline APIリファレンスCreateCustomActionTypeのActionTypeSettings「」およびThirdPartyURL「」を参照してください。アクション構造の要件とアクションの作成方法の詳細については、「CodePipeline パイプライン構造リファレンス」を参照してください。

2. JSON ファイルを保存し、簡単に覚えられる名前 (例：MyCustomAction.json)。

3. AWS CLIをインストールしたコンピュータで、ターミナルセッション (Linux、OS X、Unix) またはコマンドプロンプト (Windows) を開きます。

4. AWS CLI を使用して aws codepipeline create-custom-action-type コマンドを実行し、作成したばかりのJSONファイルの名前を指定します。

   例えば、ビルドカスタムアクションを作成するには以下のようにします。

   重要

   ファイル名の前に必ず file:// を含めてください。このコマンドでは必須です。

   aws codepipeline create-custom-action-type --cli-input-json file://MyCustomAction.json

5. このコマンドは、作成したカスタムアクションの構造全体、および追加された JobList アクション設定プロパティを返します。パイプラインにカスタムアクションを追加するときは、JobList を使用して、プロバイダーからのプロジェクトのうちジョブをポーリングできるものを指定できます。これを設定しない場合、カスタムジョブワーカーがジョブをポーリングするときに、使用可能なすべてのジョブが返されます。

   例えば、前のコマンドは、次のような構造を返します。

   {
       "actionType": {
           "inputArtifactDetails": {               
               "maximumCount": 1,                
               "minimumCount": 1
          },
          "actionConfigurationProperties": [
               {
                   "secret": false,
                   "required": true,
                   "name": "ProjectName",
                   "key": true,
                   "description": "The name of the build project must be provided when this action is added to the pipeline."
               }
           ],
           "outputArtifactDetails": {               
               "maximumCount": 0,                
               "minimumCount": 0
           },
           "id": {
               "category": "Build",
               "owner": "Custom",
               "version": "1",
               "provider": "My-Build-Provider-Name"
           },
           "settings": {
               "entityUrlTemplate": "https://my-build-instance/job/{Config:ProjectName}/",
               "executionUrlTemplate": "https://my-build-instance/job/mybuildjob/lastSuccessfulBuild/{ExternalExecutionId}/"
           }
       }
   }

   注記

   create-custom-action-type コマンドの出力の一部として、 idセクションには "owner": "Custom". CodePipeline automatically assigns がカスタムアクションタイプの所有者Customとして含まれています。create-custom-action-type コマンドまたは update-pipeline コマンドを使用する場合、この値を割り当てまたは変更することはできません。

Amazon EC2インスタンスを設定するには

1. Amazon の詳細を確認しEC2、統合に適した選択であるかどうかを判断します。詳細については、「Amazon EC2 - Virtual Server Hosting」を参照してください。

2. Amazon EC2インスタンスの作成を開始します。詳細については、「Amazon EC2 Linux インスタンスの開始方法」を参照してください。

ID フェデレーションをセットアップするには

1. IAM 認証フェデレーションの詳細について学習します。詳細については、「フェデレーションの管理」を参照してください。

2. 「一時的なアクセス権を付与するシナリオ」の例を参照して、カスタムアクションのニーズに最適な一時アクセスのシナリオを確認します。

3. インフラストラクチャに関連する ID フェデレーションのコード例を確認します。例えば、以下の参照先をご覧ください。

   • Active Directory ユースケースのための ID フェデレーションのサンプルアプリケーション

4. ID フェデレーションの設定を開始します。詳細については、IAM「 ユーザーガイド」の「アイデンティティプロバイダーとフェデレーション」を参照してください。

1. ターミナルセッション (Linux、macOS または Unix) またはコマンドプロンプト (Windows) を開き、 get-pipeline コマンドを実行して、編集するパイプライン構造をJSONファイルにコピーします。例えば、MyFirstPipeline という名前のパイプラインの場合は、以下のコマンドを入力します。

   aws codepipeline get-pipeline --name MyFirstPipeline >pipeline.json

   このコマンドは何も返しませんが、作成したファイルは、コマンドを実行したディレクトリにあります。

2. 任意のテキストエディタでJSONファイルを開き、ファイルの構造を変更して、カスタムアクションを既存のステージに追加します。

   注記

   そのステージでアクションを別のアクションと並行して実行する場合は、そのアクションと同じ runOrder 値を割り当てます。

   例えば、パイプラインの構造を変更して Build という名前のステージを追加し、そのステージにビルドカスタムアクションを追加するには、次のように を変更JSONしてデプロイステージの前にビルドステージを追加します。

   ,
       {
         "name": "MyBuildStage",
         "actions":  [
                 {
                   "inputArtifacts": [
                   {
                      "name": "MyApp"
                    }
                      ],
                       "name": "MyBuildCustomAction",
                       "actionTypeId": {
                           "category": "Build",
                           "owner": "Custom",
                           "version": "1",
                           "provider": "My-Build-Provider-Name"
                       },
                       "outputArtifacts": [
                           {
                             "name": "MyBuiltApp"
                           }
                       ],
                       "configuration": {
                           "ProjectName": "MyBuildProject"
                       },
                       "runOrder": 1
                   }
               ]
           },      
           {
               "name": "Staging",
               "actions": [
                       {
                           "inputArtifacts": [
                               {
                                   "name": "MyBuiltApp"
                               }
                           ],
                           "name": "Deploy-CodeDeploy-Application",
                           "actionTypeId": {
                               "category": "Deploy",
                               "owner": "AWS",
                               "version": "1",
                               "provider": "CodeDeploy"
                           },
                           "outputArtifacts": [],
                           "configuration": {
                               "ApplicationName": "CodePipelineDemoApplication",
                               "DeploymentGroupName": "CodePipelineDemoFleet"
                           },
                           "runOrder": 1
                       }
                   ]
                }      
       ]
   }

3. 変更を適用するには、次のようなパイプラインJSONファイルを指定して update-pipeline コマンドを実行します。

   重要

   ファイル名の前に必ず file:// を含めてください。このコマンドでは必須です。

   aws codepipeline update-pipeline --cli-input-json file://pipeline.json

   このコマンドは、編集したパイプラインの構造全体を返します。

4. CodePipeline コンソールを開き、編集したパイプラインの名前を選択します。

   そのパイプラインには、行った変更が示されます。ソース場所を次に変更すると、修正した構造のパイプラインによりそのリビジョンが実行されます。