Déclaration d'action

Le niveau d'action d'un pipeline possède une structure de base qui inclut les paramètres et la syntaxe suivants. Pour plus d'informations, consultez l'ActionDeclarationobjet dans le guide de l'CodePipeline API.

L'exemple suivant montre le niveau d'action de la structure du pipeline en JSON et en YAML.

 
. . . 

  stages:
    - name: Source
      actions:
        - name: Source
          actionTypeId:
            category: Source
            owner: AWS
            provider: S3
            version: '1'
          runOrder: 1
          configuration:
            PollForSourceChanges: 'false'
            S3Bucket: amzn-s3-demo-bucket
            S3ObjectKey: codedeploy_linux.zip
          outputArtifacts:
            - name: SourceArtifact
          inputArtifacts: []
          region: us-west-2
          namespace: SourceVariables
    - name: Build
      actions:
        - name: Build
          actionTypeId:
            category: Build
            owner: AWS
            provider: CodeBuild
            version: '1'
          runOrder: 1
          configuration:
            EnvironmentVariables: >-
              [{"name":"ETag","value":"#{SourceVariables.ETag}","type":"PLAINTEXT"}]
            ProjectName: my-project
          outputArtifacts:
            - name: BuildArtifact
          inputArtifacts:
            - name: SourceArtifact
          region: us-west-2
          namespace: BuildVariables
          runOrder: 1
          configuration:
            CustomData: >-
              Here are the exported variables from the build action: S3 ETAG:
              #{BuildVariables.ETag}
          outputArtifacts: []
          inputArtifacts: []
          region: us-west-2

Pour obtenir la liste des exemples des détails de configuration correspondant au type de fournisseur, consultez Paramètres de configuration valides pour chaque type de fournisseur.

La structure de l'action impose les critères suivants :

name

Le nom de l'action.

region

Pour les actions où le fournisseur est un Service AWS, le Région AWS de la ressource.

Les actions interrégionales utilisent le Region champ pour indiquer l' Région AWS endroit où les actions doivent être créées. Les AWS ressources créées pour cette action doivent être créées dans la même région que celle indiquée region sur le terrain. Vous ne pouvez pas créer d'actions inter-régions pour les types d'action suivants :

roleArn

ARN du rôle de service IAM qui effectue l'action déclarée. Cela est supposé par le biais du ROLearn spécifié au niveau du pipeline.

namespace

Les actions peuvent être configurées avec des variables. Vous utilisez le champ namespace pour définir l'espace de noms et les informations de variable pour les variables d'exécution. Pour plus d'informations sur les variables d'exécution et les variables de sortie d'action, consultez Référence aux variables.

actionTypeId

L'ID du type d'action est identifié comme une combinaison des quatre champs suivants.

category

Type d'action, ou d'étape, dans le pipeline, telle qu'une action source. Chaque type d'action possède un ensemble spécifique de fournisseurs d'actions valides. Pour obtenir la liste des fournisseurs valides par type d'action, consultez leRéférence sur la structure des actions.

Voici les actionTypeId catégories valides (types d'action) pour CodePipeline :

owner

Pour tous les types d'actions actuellement pris en charge, la seule chaîne propriétaire valide est AWSThirdParty, ouCustom. Pour connaître la chaîne propriétaire valide pour une action spécifique, consultez leRéférence sur la structure des actions.

Pour plus d’informations, consultez la page Référence de l’API CodePipeline .

version

Version de l'action.

provider

Le fournisseur d'actions, tel que CodeBuild.

InputArtifacts

Ce champ contient la structure de l'artefact d'entrée, si elle est prise en charge pour la catégorie d'action. L'artefact d'entrée d'une action doit correspondre exactement à l'artefact de sortie déclaré lors d'une action précédente. Par exemple, si une action précédente comprend la déclaration suivante :

"outputArtifacts": [
    {
    "MyApp"
    }
],

et il n'y a pas d'autres artefacts de sortie, alors l'artefact d'entrée d'une action suivante doit être :

"inputArtifacts": [
    {
    "MyApp"
    }
],

Par exemple, une action source ne peut pas contenir d'artefacts d'entrée car il s'agit de la première action du pipeline. Cependant, une action source comportera toujours des artefacts de sortie qui seront traités par l'action suivante. Les artefacts de sortie d'une action source sont les fichiers d'application du référentiel source, compressés et fournis via le bucket d'artefacts, qui sont traités par l'action suivante, telle qu'une CodeBuild action qui agit sur les fichiers de l'application à l'aide de commandes de génération.

À titre d'exemple d'actions qui ne peuvent pas avoir d'artefacts de sortie, les actions de déploiement n'ont pas d'artefacts de sortie car ces actions sont généralement les dernières actions d'un pipeline.

name

Le nom de l'artefact pour les artefacts d'entrée de l'action.

outputArtifacts

Les noms des artefacts de sortie doivent être uniques dans un pipeline. Par exemple, un pipeline peut inclure une action dotée d'un artefact de sortie nommé "MyApp" et une autre action dotée d'un artefact de sortie nommé "MyBuiltApp". Cependant, un pipeline ne peut pas contenir deux actions contenant toutes deux un artefact de sortie nommé "MyApp".

Ce champ contient la structure de l'artefact en sortie, si elle est prise en charge pour la catégorie d'action. L'artefact de sortie d'une action doit correspondre exactement à l'artefact de sortie déclaré lors d'une action précédente. Par exemple, si une action précédente comprend la déclaration suivante :

"outputArtifacts": [
    {
    "MyApp"
    }
],

et il n'y a pas d'autres artefacts de sortie, alors l'artefact d'entrée d'une action suivante doit être :

"inputArtifacts": [
    {
    "MyApp"
    }
],

Par exemple, une action source ne peut pas contenir d'artefacts d'entrée car il s'agit de la première action du pipeline. Cependant, une action source comportera toujours des artefacts de sortie qui seront traités par l'action suivante. Les artefacts de sortie d'une action source sont les fichiers d'application du référentiel source, compressés et fournis via le bucket d'artefacts, qui sont traités par l'action suivante, telle qu'une CodeBuild action qui agit sur les fichiers de l'application à l'aide de commandes de génération.

À titre d'exemple d'actions qui ne peuvent pas avoir d'artefacts de sortie, les actions de déploiement n'ont pas d'artefacts de sortie car ces actions sont généralement les dernières actions d'un pipeline.

name

Le nom de l'artefact pour les artefacts de sortie de l'action.

configuration(par le fournisseur d'actions)

La configuration de l'action contient des détails et des paramètres adaptés au type de fournisseur. Dans la section ci-dessous, les exemples de paramètres de configuration d'action sont spécifiques à l'action source S3.

La configuration de l'action et les limites des artefacts d'entrée/sortie peuvent varier selon le fournisseur d'actions. Pour une liste d'exemples de configuration d'actions par fournisseur d'actions, voir Référence sur la structure des actions et le tableau dansParamètres de configuration valides pour chaque type de fournisseur. Le tableau fournit un lien vers la référence d'action pour chaque type de fournisseur, qui répertorie en détail les paramètres de configuration de chaque action. Pour un tableau présentant les limites d'artefacts d'entrée et de sortie pour chaque fournisseur d'actions, voirArtefacts d'entrée et de sortie valides pour chaque type d'action.

Les considérations suivantes s'appliquent à l'utilisation des actions :

runOrder

Nombre entier positif qui indique l'ordre d'exécution de l'action au cours de l'étape. Les actions parallèles de l'étape sont indiquées comme ayant le même entier. Par exemple, deux actions avec un ordre d'exécution de deux s'exécuteront en parallèle après l'exécution de la première action de la phase.

La valeur par défaut runOrder pour une action est 1. La valeur doit être un nombre entier positif (nombre naturel). Vous ne pouvez pas utiliser des fractions, des nombres décimaux, négatifs ou zéro. Pour spécifier une séquence d'actions en série, utilisez le plus petit nombre pour la première action et les plus grands nombres pour chacune des autres actions de la séquence. Pour spécifier des actions parallèles, utilisez le même nombre entier pour chaque action que vous souhaitez exécuter en parallèle. Dans la console, vous pouvez définir une séquence en série pour une action en choisissant Ajouter un groupe d'actions au niveau de l'étape où vous souhaitez qu'elle s'exécute, ou vous pouvez spécifier une séquence parallèle en choisissant Ajouter une action. Le groupe d'actions fait référence à un ordre d'exécution d'une ou de plusieurs actions au même niveau.

Par exemple, si vous souhaitez que trois actions s'exécutent en séquence dans une étape, vous devez attribuer à la première action runOrder la valeur 1, à la seconde action runOrder la valeur 2 et à la troisième runOrder la valeur 3. Toutefois, si vous souhaitez que les deuxième et troisième actions s'exécutent en parallèle, vous devez attribuer à la première action la runOrder valeur 1 et aux deuxième et troisième actions runOrder la valeur 2.