Mit Aktionstypen arbeiten

Um eine Anfrage für eine Lambda-Integration zu registrieren

• Senden Sie mithilfe des folgenden Formulars eine Anfrage an das CodePipeline Serviceteam.

  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-Regionen where your action will be available
  
  5. Will this be available as a public action?
  

Um eine Anfrage für eine Integration von Arbeitnehmern zu registrieren

• Senden Sie mit dem folgenden Formular eine Anfrage an das CodePipeline Serviceteam.

  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-Regionen where your action will be available
  
  5. Will this be available as a public action?

Um Ihren Aktionstyp von der CodePipeline Konsole aus zu einer vorhandenen Pipeline hinzuzufügen

1. Melden Sie sich bei der an AWS-Managementkonsole und öffnen Sie die CodePipeline Konsole unter http://console.aws.amazon.com/codesuite/codepipeline/home.

2. Wählen Sie in der Liste der Pipelines die Pipeline aus, zu der Sie den Aktionstyp hinzufügen möchten.

3. Wählen Sie auf der Übersichtsseite der Pipeline die Option Bearbeiten aus.

4. Wählen Sie, ob Sie die Phase bearbeiten möchten. Wählen Sie in der Phase, in der Sie Ihren Aktionstyp hinzufügen möchten, Aktionsgruppe hinzufügen aus. Die Seite „Aktion bearbeiten“ wird angezeigt.

5. Geben Sie auf der Seite Aktion bearbeiten im Feld Aktionsname einen Namen für die Aktion ein. Dies ist der Name, der für die Phase in Ihrer Pipeline angezeigt wird.

6. Wählen Sie unter Aktionsanbieter Ihren Aktionstyp aus der Liste aus.

   Beachten Sie, dass der Wert in der Liste auf dem in der Aktionstyp-Definitionsdatei provider angegebenen Wert basiert.

7. Geben Sie im Feld Eingabeartefakte den Namen des Artefakts in diesem Format ein:

   Artifactname::FileName

   Beachten Sie, dass die zulässigen Mindest- und Höchstmengen auf der Grundlage der in der Definitionsdatei für den Aktionstyp inputArtifactDetails angegebenen Werte definiert werden.

8. Wählen Sie Verbinden mit < Action_Name >.

   Ein Browserfenster wird geöffnet und stellt eine Verbindung zu der Website her, die Sie für Ihren Aktionstyp erstellt haben.

9. Melden Sie sich als Kunde auf Ihrer Website an und führen Sie die Schritte aus, die ein Kunde unternimmt, um Ihren Aktionstyp zu verwenden. Deine Schritte variieren je nach Aktionskategorie, Website und Konfiguration, beinhalten aber in der Regel eine Abschlussaktion, die den Kunden zur Seite „Aktion bearbeiten“ zurückbringt.

10. Auf der Seite CodePipeline „Aktion bearbeiten“ werden die zusätzlichen Konfigurationsfelder für die Aktion angezeigt. Bei den angezeigten Feldern handelt es sich um die Konfigurationseigenschaften, die Sie in der Aktionsdefinitionsdatei angegeben haben. Geben Sie die Informationen in die Felder ein, die für Ihren Aktionstyp angepasst sind.

    Wenn in der Aktionsdefinitionsdatei beispielsweise eine Eigenschaft mit dem Namen angegeben wurdeHost, wird auf der Seite „Aktion bearbeiten“ für Ihre Aktion ein Feld mit der Bezeichnung Host angezeigt.

11. Geben Sie im Feld Ausgabeartefakte den Namen des Artefakts in diesem Format ein:

    Artifactname::FileName

    Beachten Sie, dass die zulässigen Mindest- und Höchstmengen auf der Grundlage der in der Definitionsdatei für den Aktionstyp outputArtifactDetails angegebenen Werte definiert werden.

12. Wählen Sie Fertig, um zur Seite mit den Pipeline-Details zurückzukehren.

    Anmerkung

    Ihre Kunden können optional die CLI verwenden, um den Aktionstyp zu ihrer Pipeline hinzuzufügen.

13. Um Ihre Aktion zu testen, übernehmen Sie eine Änderung an der in der Quellphase der Pipeline angegebenen Quelle oder folgen Sie den Schritten unter Manuelles Starten einer Pipeline.

Um einen Aktionstyp anzuzeigen

1. Erstellen Sie eine JSON-Eingabedatei und benennen Sie die Dateifile.json. Fügen Sie Ihre Aktionstyp-ID im JSON-Format hinzu, wie im folgenden Beispiel gezeigt.

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

2. Führen Sie den Befehl in einem Terminalfenster oder in der get-action-type Befehlszeile aus.

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

   Dieser Befehl gibt die Ausgabe der Aktionsdefinition für einen Aktionstyp zurück. Dieses Beispiel zeigt einen Aktionstyp, der mit dem Lambda-Integrationsmodell erstellt wurde.

   {
       "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. Verwenden Sie den get-action-type Befehl, um die Struktur für Ihren Aktionstyp abzurufen. Kopieren Sie die Struktur.

2. Erstellen Sie eine JSON-Eingabedatei und benennen Sie sieaction.json. Fügen Sie die Aktionstyp-Struktur ein, die Sie im vorherigen Schritt kopiert haben. Aktualisieren Sie alle Parameter, die Sie ändern möchten. Sie können auch optionale Parameter hinzufügen.

   Weitere Informationen zu den Parametern für die Eingabedatei finden Sie in der Beschreibung der Aktionsdefinitionsdatei unterSchritt 2: Erstellen Sie eine Definitionsdatei für den Aktionstyp.

   Das folgende Beispiel zeigt, wie ein Beispiel-Aktionstyp aktualisiert wird, der mit dem Lambda-Integrationsmodell erstellt wurde. In diesem Beispiel werden die folgenden Änderungen vorgenommen:

   • Ändert den provider Namen inTestProvider1.

   • Fügen Sie ein Job-Timeout-Limit von 900 Sekunden hinzu.

   • Fügt eine Aktionskonfigurationseigenschaft mit dem Namen hinzuHost, die dem Kunden angezeigt wird, der die Aktion verwendet.

     {
         "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. Führen Sie im Terminal oder in der Befehlszeile den update-action-type Befehl aus

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

   Dieser Befehl gibt die Ausgabe des Aktionstyps zurück, die Ihren aktualisierten Parametern entspricht.