Trabajar con tipos de acciones

Para registrar una solicitud de una integración de Lambda

• Envíe una solicitud al equipo CodePipeline de servicio mediante el siguiente formulario.

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

Para registrar una solicitud de una integración de proceso de trabajo

• Envíe una solicitud al equipo CodePipeline de servicio mediante el siguiente formulario.

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

Para añadir tu tipo de acción a una canalización existente desde la CodePipeline consola

1. Inicia sesión en la CodePipeline consola AWS Management Console y ábrela en http://console.aws.amazon.com/codesuite/codepipeline/home.

2. En la lista de canalizaciones, elija la canalización a la que quieres añadir el tipo de acción.

3. En la página de vista de resumen de la canalización, elija Editar.

4. Elija editar la etapa. En la etapa en la que desea añadir la acción de aprobación, elija + Añadir grupo de acciones. Aparece la página Editar acción.

5. En la página Editar acción, en Nombre de la acción, introduzca un nombre para la acción. Este es el nombre que se muestra para la etapa de su proceso.

6. En el Proveedor de acciones, elige el tipo de acción de la lista.

   Tenga en cuenta que el valor de la lista se basa en el provider especificado en el archivo de definición del tipo de acción.

7. En Artefactos de entrada, introduzca el nombre del artefacto en este formato:

   Artifactname::FileName

   Tenga en cuenta que las cantidades mínimas y máximas permitidas se definen en función de los inputArtifactDetails especificados en el archivo de definición del tipo de acción.

8. Seleccione Conectar a <Nombre_aación>.

   Se abre una ventana del navegador que conecta con el sitio web que ha creado para su tipo de acción.

9. Inicie sesión en su sitio web como cliente y complete los pasos que sigue un cliente para usar su tipo de acción. Los pasos variarán en función de la categoría de la acción, el sitio web y la configuración, pero normalmente incluyen una acción de finalización que devuelve al cliente a la página Editar acción.

10. En la página CodePipeline Editar acción, se muestran los campos de configuración adicionales de la acción. Los campos que se muestran son las propiedades de configuración que especificó en el archivo de definición de acciones. Introduzca la información en los campos personalizados para el tipo de acción.

    Por ejemplo, si el archivo de definición de acciones especificó un nombre de propiedad Host, y un campo con la etiqueta Host con la etiqueta para la acción en la página Editar acción.

11. En Artefactos de salida, introduzca el nombre del artefacto en este formato:

    Artifactname::FileName

    Tenga en cuenta que las cantidades mínimas y máximas permitidas se definen en función de los outputArtifactDetails especificados en el archivo de definición del tipo de acción.

12. Elija Listo para volver a la página de detalles de la canalización.

    nota

    Si lo desea, sus clientes pueden utilizar la CLI para añadir el tipo de acción a su canalización.

13. Para probar su acción, confirme un cambio en el origen especificado en la etapa de origen de la canalización o siga los pasos indicados en Iniciar manualmente una canalización.

Para ver un tipo de acción

1. Cree un archivo JSON de entrada con el nombre file.json. Agregue su ID de tipo de acción en formato JSON, tal como se muestra en el siguiente ejemplo.

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

2. En una ventana de terminal o en la línea de comandos, ejecute el comando get-action-type.

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

   Este comando devuelve el resultado de la definición de acción para un tipo de acción. En este ejemplo, se muestra un tipo de acción que se creó con el modelo de integración de 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. Use el comando get-action-type para obtener la estructura del tipo de acción. Copie la estructura.

2. Cree un archivo de entrada JSON con el nombre action.json. Pegue en ella la estructura del tipo de acción que copió en el paso anterior. Actualice los parámetros que desee cambiar. También puede añadir parámetros opcionales.

   Para obtener más información sobre los parámetros del archivo de entrada, consulte la descripción del archivo de definición de acciones en Paso 2: Crear un archivo de definición de tipo de acción.

   En el siguiente ejemplo, se muestra cómo actualizar un tipo de acción de ejemplo creado con el modelo de integración de Lambda. En este ejemplo, se realizan los siguientes cambios:

   • Cambie el nombre de provider a TestProvider1.

   • Añada un límite de tiempo de espera del trabajo de 900 segundos.

   • Añade una propiedad de configuración de acciones llamada Host que se muestra al cliente que utiliza la acción.

     {
         "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. En el terminal o la línea de comandos, ejecute el comando update-action-type.

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

   Este comando devuelve el resultado del tipo de acción para que coincida con los parámetros actualizados.