使用動作類型

若要註冊 Lambda 整合的請求

• 使用以下表單向 CodePipeline 服務團隊發送請求。

  This issue will track the onboarding of [Name] in CodePipeline.
  
  
  [Contact engineer] will be the primary point of contact for this integration.
  
  Name of the action type as you want it to appear to customers: Example.com Testing
  
  Initial onboard checklist:
  
  1. Attach an action type definition file in JSON format. This includes the schema for the action type
  
  2. A list of test accounts for the allowlist which can access the new action type [{account, account_name}]
  
  3. The Lambda function ARN
  
  4. List of AWS 區域 where your action will be available
  
  5. Will this be available as a public action?
  

若要註冊工作者整合的請求

• 使用以下表單向 CodePipeline 服務團隊發送請求。

  This issue will track the onboarding of [Name] in CodePipeline.
  
  [Contact engineer] will be the primary point of contact for this integration.
  
  
  Name of the action type as you want it to appear to customers: Example.com Testing
  
  Initial onboard checklist:
  
  1. Attach an action type definition file in JSON format. This includes the schema for the action type.
  
  2. A list of test accounts for the allowlist which can access the new action type [{account, account_name}]
  
  3. URL information:
  Website URL: https://www.example.com/%TestThirdPartyName%/%TestVersionNumber%
  
  Example URL pattern where customers will be able to review their configuration information for the action: https://www.example.com/%TestThirdPartyName%/%customer-ID%/%CustomerActionConfiguration%
  
  Example runtime URL pattern: https://www.example.com/%TestThirdPartyName%/%customer-ID%/%TestRunId%
  
  4. List of AWS 區域 where your action will be available
  
  5. Will this be available as a public action?

若要從 CodePipeline 主控台將動作類型新增至現有管線

1. 請登入 AWS Management Console 並開啟 CodePipeline 主控台，網址為 http://console.aws.amazon.com/codesuite/codepipeline/home。

2. 在配管清單中，選擇要新增動作類型的配管。

3. 在配管的摘要檢視頁面上，選擇 「編輯」(Edit)。

4. 選擇編輯階段。在您要新增動作類型的階段中，選擇 [新增動作群組]。「編輯」動作頁面隨即顯示。

5. 在 [編輯動作] 頁面上的 [動作名稱] 中，輸入動作的名稱。這是管線中階段所顯示的名稱。

6. 在 [動作提供者] 中，從清單中選擇您的動作類型。

   請注意，清單中的值是以動作類型定義檔案中provider指定的值為基礎。

7. 在輸入人工因素中，以下列格式輸入人工因素名稱：

   Artifactname::FileName

   請注意，允許的最小和最大數量是根據動作類型定義檔案中inputArtifactDetails指定的數量來定義的。

8. 選擇「Connect 至」<Action_Name>。

   瀏覽器視窗隨即開啟，並連線至您針對動作類型建立的網站。

9. 以客戶身份登錄到您的網站，並完成客戶使用您的操作類型所採取的步驟。您的步驟會根據您的動作類別、網站和設定而有所不同，但通常會包含將客戶返回 「編輯動作」頁面的完成動作。

10. 在 CodePipeline 「編輯」動作頁面中，會顯示動作的其他組態欄位。顯示的欄位是您在動作定義檔案中指定的組態特性。在針對您的動作類型自訂的欄位中輸入資訊。

    例如，如果動作定義檔案指定了名為的屬性Host，則標籤為「主機」(Host) 的欄位會顯示在您動作的「編輯」動作頁面上。

11. 在輸出人工因素中，以下列格式輸入人工因素名稱：

    Artifactname::FileName

    請注意，允許的最小和最大數量是根據動作類型定義檔案中outputArtifactDetails指定的數量來定義的。

12. 選擇「完成」以返回管線詳細資訊頁面。

    注意

    您的客戶可以選擇性地使用 CLI 將動作類型新增至其管道。

13. 若要測試您的動作，請將變更送至管線的來源階段中指定的來源，或遵循手動啟動管線中的步驟執行。

若要檢視動作類型

1. 創建一個輸入 JSON 文件並命名該文件file.json。以 JSON 格式新增動作類型 ID，如下列範例所示。

   {
       "category": "Test",
       "owner": "ThirdParty",
       "provider": "TestProvider",
       "version": "1"
   }

2. 在終端機視窗或命令列中，執行get-action-type命令。

   aws codepipeline get-action-type --cli-input-json file://file.json

   此指令會傳回動作類型的動作定義輸出。此範例顯示使用 Lambda 整合模型建立的動作類型。

   {
       "actionType": {
           "executor": {
               "configuration": {
                   "lambdaExecutorConfiguration": {
                       "lambdaFunctionArn": "arn:aws:lambda:us-west-2:<account-id>:function:my-function"
                   }
               },
               "type": "Lambda"
           },
           "id": {
               "category": "Test",
               "owner": "ThirdParty",
               "provider": "TestProvider",
               "version": "1"
           },
           "inputArtifactDetails": {
               "minimumCount": 0,
               "maximumCount": 1
           },
           "outputArtifactDetails": {
               "minimumCount": 0,
               "maximumCount": 1
           },
           "permissions": {
               "allowedAccounts": [
                   "<account-id>"
               ]
           },
           "properties": []
       }
   }

1. 使用get-action-type指令取得動作類型的結構。複製結構。

2. 創建一個輸入 JSON 文件並命名它action.json。將您在上一個步驟中複製的動作類型結構貼到其中。更新您要變更的任何參數。您還可以添加可選參數。

   如需有關輸入檔案參數的詳細資訊，請參閱中的動作定義檔案描述步驟 2：建立動作類型定義檔。

   下列範例顯示如何更新以 Lambda 整合模型建立的範例動作類型。此範例會進行下列變更：

   • 將provider名稱變更為TestProvider1。

   • 新增工作逾時限制為 900 秒。

   • 新增名為的動作組態屬性Host，該屬性會使用動作顯示給客戶。

     {
         "actionType": {
             "executor": {
                 "configuration": {
                     "lambdaExecutorConfiguration": {
                         "lambdaFunctionArn": "arn:aws:lambda:us-west-2:<account-id>:function:my-function"
                     }
                 },
                 "type": "Lambda",
                 "jobTimeout": 900 
             },
             "id": {
                 "category": "Test",
                 "owner": "ThirdParty",
                 "provider": "TestProvider1",
                 "version": "1"
             },
             "inputArtifactDetails": {
                 "minimumCount": 0,
                 "maximumCount": 1
             },
             "outputArtifactDetails": {
                 "minimumCount": 0,
                 "maximumCount": 1
             },
             "permissions": {
                 "allowedAccounts": [
                     "account-id"
                 ]
             },
             "properties": {
              "description": "Owned build action parameter description",
              "optional": true,
              "noEcho": false,
              "key": true,
              "queryable": false,
              "name": "Host"
              }
         }
     }
     

3. 在終端機或命令列中，執行update-action-type命令

   aws codepipeline update-action-type --cli-input-json file://action.json

   此指令會傳回動作類型輸出，以符合您更新的參數。