Référence aux variables

Cette section est fournie à des fins de référence uniquement. Pour plus d'informations sur la création de variables, consultez Utilisation des variables.

Les variables vous permettent de configurer les actions de votre pipeline avec des valeurs déterminées au moment de l'exécution du pipeline ou de l'exécution de l'action.

Certains fournisseurs d'actions produisent un ensemble défini de variables. Vous choisissez parmi des clés de variable par défaut pour ce fournisseur d'action, telles que l'ID de validation.

Pour voir step-by-step des exemples d'utilisation de variables :

Limites de variable

Pour plus d'informations sur les limites, consultez Quotas dans AWS CodePipeline.

Concepts

Cette section répertorie les termes et concepts clés liés aux variables et aux espaces de noms.

Variables

Les variables sont des paires clé-valeur qui peuvent être utilisées pour configurer dynamiquement des actions dans votre pipeline. Ces variables sont actuellement mises à disposition de trois manières :

Pour référencer ces variables dans votre configuration d'action, vous devez utiliser la syntaxe de référence de variable avec l'espace de noms correct.

Pour un exemple de flux de travail de variable, consultez Configuration des variables .

Espaces de noms

Pour que les variables puissent être référencées de manière unique, elles doivent être affectées à un espace de noms. Une fois qu’un ensemble de variables a été affecté à un espace de noms, elles peuvent être référencées dans une configuration d'action à l'aide de l'espace de noms et d’une clé de variable avec la syntaxe suivante :

#{namespace.variable_key}

Il existe trois types d'espaces de noms sous lesquels des variables peuvent être attribuées :

Cas d'utilisation des variables

Voici quelques-uns des cas d'utilisation les plus courants des variables au niveau du pipeline, qui vous aideront à déterminer comment vous pouvez utiliser les variables en fonction de vos besoins spécifiques.

Configuration des variables

Vous pouvez configurer des variables au niveau du pipeline ou au niveau de l'action dans la structure du pipeline.

Configuration des variables au niveau du pipeline

Vous pouvez ajouter une ou plusieurs variables au niveau du pipeline. Vous pouvez référencer cette valeur dans la configuration des CodePipeline actions. Vous pouvez ajouter les noms des variables, les valeurs par défaut et les descriptions lors de la création du pipeline. Les variables sont résolues au moment de l'exécution.

Vous fournissez des variables au niveau du pipeline à l'aide de l'attribut variables de la structure du pipeline. Dans l'exemple suivant, la valeur de la variable Variable1 estValue1.

       "variables": [
            {
                "name": "Variable1",
                "defaultValue": "Value1",
                "description": "description"
            }
        ]

Pour un exemple de JSON structure de pipeline, voirCréation d'un pipeline, d'étapes et d'actions.

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

Notez que l'utilisation de variables au niveau du pipeline dans tout type d'action Source n'est pas prise en charge.

Configuration des variables au niveau de l'action

Vous configurez une action pour produire des variables en déclarant un espace de noms pour l'action. L'action doit déjà être un des fournisseurs d'actions qui génère des variables. Sinon, les variables disponibles sont des variables de niveau pipeline.

Vous pouvez déclarer l'espace de noms comme suit :

Dans cet exemple, vous ajoutez le namespace paramètre à l'action CodeCommit source avec le nomSourceVariables. Cela configure l'action pour produire les variables disponibles pour ce fournisseur d'actions, telles que CommitId.

{
    "name": "Source",
    "actions": [
        {
            "outputArtifacts": [
                {
                    "name": "SourceArtifact"
                }
            ],
            "name": "Source",
            "namespace": "SourceVariables",
            "configuration": {
                "RepositoryName": "MyRepo",
                "BranchName": "mainline",
                "PollForSourceChanges": "false"
            },
            "inputArtifacts": [],
            "region": "us-west-2",
            "actionTypeId": {
                "provider": "CodeCommit",
                "category": "Source",
                "version": "1",
                "owner": "AWS"
            },
            "runOrder": 1
        }
    ]
},

Ensuite, vous configurez l'action en aval pour utiliser les variables produites par l'action précédente. Pour ce faire, procédez comme suit :

Dans cet exemple, le champ de configuration de l'action de build affiche les variables d'environnement mises à jour lors de l'exécution de l'action. L'exemple spécifie l'espace de noms et la variable pour l'ID d'exécution avec #{codepipeline.PipelineExecutionId} et l'espace de noms et la variable pour l'ID de validation avec #{SourceVariables.CommitId}.

{
    "name": "Build",
    "actions": [
        {
            "outputArtifacts": [
                {
                    "name": "BuildArtifact"
                }
            ],
            "name": "Build",
            "configuration": {
                "EnvironmentVariables": "[{\"name\":\"Release_ID\",\"value\":\"#{codepipeline.PipelineExecutionId}\",\"type\":\"PLAINTEXT\"},{\"name\":\"Commit_ID\",\"value\":\"#{SourceVariables.CommitId}\",\"type\":\"PLAINTEXT\"}]",
                "ProjectName": "env-var-test"
            },
            "inputArtifacts": [
                {
                    "name": "SourceArtifact"
                }
            ],
            "region": "us-west-2",
            "actionTypeId": {
                "provider": "CodeBuild",
                "category": "Build",
                "version": "1",
                "owner": "AWS"
            },
            "runOrder": 1
        }
    ]
},

Résolution des variables

Chaque fois qu'une action est exécutée dans le cadre d'une exécution de pipeline, les variables produites peuvent être utilisées dans toute action dont l'exécution est garantie après l'action de production. Pour utiliser ces variables dans une action de consommation, vous pouvez les ajouter à la configuration de l'action de consommation en utilisant la syntaxe indiquée dans l'exemple précédent. Avant d'exécuter une action consommatrice, il CodePipeline résout toutes les références de variables présentes dans la configuration avant de lancer l'exécution de l'action.

Règles pour les variables

Les règles suivantes vous aident à configurer les variables :

Variables disponibles pour les actions de pipeline

Le fournisseur d'actions détermine les variables qui peuvent être générées par l'action.

Pour step-by-step les procédures de gestion des variables, voirUtilisation des variables.

Actions avec des clés variables définies

Contrairement à un espace de noms que vous pouvez choisir, les actions suivantes utilisent des clés variables qui ne peuvent pas être modifiées. Par exemple, pour le fournisseur d'actions Amazon S3, seules les clés de VersionId variable ETag et sont disponibles.

Chaque exécution possède également un ensemble de variables de pipeline CodePipeline générées qui contiennent des données sur l'exécution, telles que l'ID de version du pipeline. Ces variables peuvent être utilisées par n'importe quelle action du pipeline.

CodePipeline variable d'ID d'exécution

Variables de sortie ECR d'action Amazon

AWS CloudFormation StackSets variables de sortie d'action

CodeCommit variables de sortie d'action

CodeStarSourceConnection variables de sortie d'action

GitHub variables de sortie GitHub d'action (action version 1)

Variables de sortie d'action S3

Actions avec des touches variables configurées par l'utilisateur

Pour les actions CodeBuild AWS CloudFormation,, et Lambda, les clés variables sont configurées par l'utilisateur.

CloudFormation variables de sortie d'action

CodeBuild variables de sortie d'action

#{BuildVariables.EnvVar}

Variables de sortie de l'action Lambda