name roleArn artifactStoreOU artifactStores stages version executionMode pipelineType variables triggers metadata

Déclaration relative au pipeline

Le niveau du pipeline et des métadonnées d'un pipeline possède une structure de base qui inclut les paramètres et la syntaxe suivants. Le paramètre de pipeline représente la structure des actions et des étapes à exécuter dans le pipeline.

Pour plus d'informations, consultez l'PipelineDeclarationobjet dans le CodePipeline APIGuide.

L'exemple suivant montre le niveau de pipeline et de métadonnées de la structure de pipeline à la fois dans un pipeline de type V2 JSON et dans le YAML cas d'un pipeline de type V2.

YAML


pipeline:
  name: MyPipeline
  roleArn: >-
    arn:aws:iam::ACCOUNT_ID:role/service-role/AWSCodePipelineServiceRole-us-west-2-MyPipeline
  artifactStore:
    type: S3
    location: amzn-s3-demo-bucket
  stages:
    ...
  version: 6
  executionMode: SUPERSEDED
  pipelineType: V2
  variables:
  - name: MyVariable
    defaultValue: '1'
  triggers:
  - providerType: CodeStarSourceConnection
    gitConfiguration:
      sourceActionName: Source
      push:
      - branches:
          includes:
          - main
          excludes:
          - feature-branch
      pullRequest:
      - events:
        - CLOSED
        branches:
          includes:
          - main*
metadata:
  pipelineArn: 'arn:aws:codepipeline:us-west-2:ACCOUNT_ID:MyPipeline'
  created: '2019-12-12T06:49:02.733000+00:00'
  updated: '2020-09-10T06:34:07.447000+00:00'

JSON


{
    "pipeline": {
        "name": "MyPipeline",
        "roleArn": "arn:aws:iam::ACCOUNT_ID:role/service-role/AWSCodePipelineServiceRole-us-west-2-MyPipeline",
        "artifactStore": {
            "type": "S3",
            "location": "amzn-s3-demo-bucket"
        },
        "stages": {
            ...   
    },
        "version": 6,
        "executionMode": "SUPERSEDED",
                "pipelineType": "V2",
        "variables": [
            {
                "name": "MyVariable",
                "defaultValue": "1"
            }
        ],
        "triggers": [
            {
                "providerType": "CodeStarSourceConnection",
                "gitConfiguration": {
                    "sourceActionName": "Source",
                    "push": [
                        {
                            "branches": {
                                "includes": [
                                    "main"
                                ],
                                "excludes": [
                                    "feature-branch"
                                ]
                            }
                        }
                    ],
                    "pullRequest": [
                        {
                            "events": [
                                "CLOSED"
                            ],
                            "branches": {
                                "includes": [
                                    "main*"
                                ]
                            }
                        }
                    ]
                }
            }
        ]
    },
    "metadata": {
        "pipelineArn": "arn:aws:codepipeline:us-west-2:ACCOUNT_ID:MyPipeline",
        "created": "2019-12-12T06:49:02.733000+00:00",
        "updated": "2020-09-10T06:34:07.447000+00:00"
    }
}

`name`

Nom du pipeline. Lorsque vous modifiez ou mettez à jour un pipeline, le nom du pipeline ne peut pas être modifié.

Note

Si vous souhaitez renommer un pipeline existant, vous pouvez utiliser la CLI get-pipeline commande pour créer un JSON fichier contenant la structure de votre pipeline. Vous pouvez ensuite utiliser la CLI create-pipeline commande pour créer un pipeline avec cette structure et lui donner un nouveau nom.

`roleArn`

IAMARNPour le rôle de CodePipeline service, tel que arn:aws:iam : :80398:role/ _Service_Role. EXAMPLE CodePipeline

Pour utiliser la console afin d'afficher le rôle du service de pipeline ARN plutôt que la JSON structure, choisissez votre pipeline dans la console, puis sélectionnez Paramètres. Sous l'onglet Général, le ARN champ Rôle du service s'affiche.

`artifactStore`OU `artifactStores`

Le artifactStore champ contient le type de compartiment d'artefacts et l'emplacement d'un pipeline comportant toutes les actions dans la même AWS région. Si vous ajoutez des actions dans une région différente de votre pipeline, le artifactStores mappage est utilisé pour répertorier le compartiment d'artefacts pour chaque AWS région dans laquelle les actions sont exécutées. Lorsque vous créez ou modifiez un pipeline, vous devez avoir un compartiment d'artefact dans le pipeline Région, puis vous devez disposer d'un compartiment d'artefact par région dans laquelle vous prévoyez d'exécuter une action.

Note

Dans la structure du pipeline, vous devez inclure l'un artifactStore ou l'autre artifactStores de vos pipelines, mais vous ne pouvez pas utiliser les deux. Si vous créez une action entre régions dans votre pipeline, vous devez utiliser artifactStores.

L'exemple suivant illustre la structure de base d'un pipeline avec des actions inter-régions qui utilise le paramètre artifactStores :


    "pipeline": {
        "name": "YourPipelineName",
        "roleArn": "CodePipeline_Service_Role",
        "artifactStores": {
            "us-east-1": {
                "type": "S3",
                "location": "S3 artifact bucket name, such as amzn-s3-demo-bucket"
            },
            "us-west-2": {
                "type": "S3",
                "location": "S3 artifact bucket name, such as amzn-s3-demo-bucket"
            }
        },
        "stages": [
            {

...

`type`

Type d'emplacement du compartiment d'artefacts, spécifié comme Amazon S3.

`location`

Le nom du compartiment Amazon S3 généré automatiquement pour vous la première fois que vous créez un pipeline à l'aide de la console, par exemple codepipeline-us-east -2-1234567890, ou tout compartiment Amazon S3 que vous fournissez à cette fin

`stages`

Ce paramètre contient le nom de chaque étape du pipeline. Pour plus d'informations sur les paramètres et la syntaxe au niveau de l'étape de la structure du pipeline, consultez l'StageDeclarationobjet dans le CodePipeline APIGuide.

La structure du pipeline pour les étapes répond aux exigences suivantes :

Un pipeline doit contenir au moins deux étapes.
La première étape d'un pipeline doit contenir au moins une action source. Elle peut contenir des actions source uniquement.
Seule la première étape d'un pipeline peut contenir des actions source.
Au moins une étape dans chaque pipeline doit comporter une action autre qu'une action source.
Tous les noms d'étapes dans un pipeline doivent être uniques.
Les noms de scène ne peuvent pas être modifiés dans la CodePipeline console. Si vous modifiez le nom d'une étape à l'aide de AWS CLI, et que l'étape contient une action avec un ou plusieurs paramètres secrets (tels qu'un OAuth jeton), la valeur de ces paramètres secrets n'est pas préservée. Vous devez saisir manuellement la valeur des paramètres (qui sont masqués par quatre astérisques dans le champ JSON renvoyé par le AWS CLI) et les inclure dans la structure. JSON

`version`

Le numéro de version d'un pipeline est automatiquement généré et mis à jour chaque fois que vous mettez à jour le pipeline.

`executionMode`

Vous pouvez définir le mode d'exécution du pipeline afin de pouvoir définir le comportement du pipeline pour des exécutions consécutives, telles que la mise en file d'attente, le remplacement ou l'exécution en mode parallèle. Pour de plus amples informations, veuillez consulter Définir ou modifier le mode d'exécution du pipeline.

`pipelineType`

Le type de pipeline spécifie la structure et les fonctionnalités disponibles dans le pipeline, par exemple pour un pipeline de type V2. Pour de plus amples informations, veuillez consulter Types de canalisations.

`variables`

Les variables au niveau du pipeline sont définies lors de la création du pipeline et résolues au moment de son exécution. Pour de plus amples informations, veuillez consulter Référence aux variables. Pour un didacticiel avec une variable au niveau du pipeline transmise au moment de l'exécution du pipeline, voir. Tutoriel : Utiliser des variables au niveau du pipeline

`triggers`

Les déclencheurs vous permettent de configurer votre pipeline pour qu'il démarre sur un type d'événement particulier ou sur un type d'événement filtré, par exemple lorsqu'une modification est détectée sur une branche ou une pull request en particulier. Les déclencheurs sont configurables pour les actions source avec des connexions qui utilisent l'CodeStarSourceConnectionaction dans CodePipeline GitHub, telles que Bitbucket et GitLab. Pour plus d'informations sur les actions source qui utilisent des connexions, consultezConnectez-vous à des fournisseurs de sources tiers à l'aide de CodeConnections.

Pour de plus amples informations, veuillez consulter Automatisez le démarrage des pipelines en utilisant des déclencheurs et des filtres.

Note

Les actions source CodeCommit et S3 nécessitent soit une ressource de détection des modifications configurée (une EventBridge règle), soit l'option permettant d'interroger le référentiel pour connaître les modifications de source. Pour les pipelines dotés d'une action source Bitbucket ou GitHub Enterprise Server, il n'est pas nécessaire de configurer un webhook ou d'effectuer un sondage par défaut. GitHub L'action Connexions gère pour vous la détection des modifications.

`metadata`

Les champs des métadonnées du pipeline sont différentes de la structure du pipeline et ne peuvent pas être modifiés. Lorsque vous mettez à jour un pipeline, la date du champ des métadonnées updated change automatiquement.

`pipelineArn`

Le nom de la ressource Amazon (ARN) du pipeline.

Pour utiliser la console pour afficher le pipeline ARN plutôt que la JSON structure, choisissez votre pipeline dans la console, puis sélectionnez Paramètres. Sous l'onglet Général, le ARN champ Pipeline s'affiche.

`created`

Date et heure de création du pipeline.

`updated`

Date et heure de la dernière mise à jour du pipeline.

Avertissement JavaScript est désactivé ou n'est pas disponible dans votre navigateur.

Pour que vous puissiez utiliser la documentation AWS, Javascript doit être activé. Vous trouverez des instructions sur les pages d'aide de votre navigateur.

Conventions de rédaction

Référence sur la structure des pipelines

Déclaration d'étape