Riferimento alle variabili

Questa sezione è solo per riferimento. Per informazioni sulla creazione di variabili, vedere Utilizzo delle variabili.

Le variabili consentono di configurare le azioni della pipeline con valori determinati al momento dell'esecuzione della pipeline o dell'esecuzione dell'azione.

Alcuni provider di azioni producono un insieme definito di variabili. È possibile scegliere tra le chiavi variabili predefinite per tale provider di azioni, ad esempio l'ID di commit.

Per vedere step-by-step esempi di utilizzo delle variabili:

Limiti variabili

Per informazioni sui limiti, vedere Quote in AWS CodePipeline.

Concetti

Questa sezione elenca i termini e i concetti chiave relativi alle variabili e agli spazi dei nomi.

Variables

Le variabili sono coppie chiave-valore che possono essere utilizzate per configurare dinamicamente le azioni nella pipeline. Attualmente esistono tre modi in cui queste variabili vengono rese disponibili:

Per fare riferimento a queste variabili nella configurazione dell'azione, è necessario utilizzare la sintassi di riferimento variabile con lo spazio dei nomi corretto.

Per un flusso di lavoro variabile di esempio, vedere Configurazione delle variabili .

Spazi dei nomi

Per garantire che le variabili possano essere referenziate in modo univoco, devono essere assegnate a uno spazio dei nomi. Dopo aver assegnato un set di variabili a uno spazio dei nomi, è possibile fare riferimento a queste variabili in una configurazione di azione utilizzando lo spazio dei nomi e la chiave variabile con la seguente sintassi:

#{namespace.variable_key}

Esistono tre tipi di namespace in base ai quali è possibile assegnare le variabili:

Casi d'uso per le variabili

Di seguito sono riportati alcuni dei casi d'uso più comuni per le variabili a livello di pipeline, che consentono di determinare come utilizzare le variabili per esigenze specifiche.

Configurazione delle variabili

È possibile configurare le variabili a livello di pipeline o a livello di azione nella struttura della pipeline.

Configurazione delle variabili a livello di pipeline

È possibile aggiungere una o più variabili a livello di pipeline. È possibile fare riferimento a questo valore nella configurazione delle CodePipeline azioni. È possibile aggiungere i nomi delle variabili, i valori predefiniti e le descrizioni quando si crea la pipeline. Le variabili vengono risolte al momento dell'esecuzione.

Le variabili vengono fornite a livello di pipeline utilizzando l'attributo variables nella struttura della pipeline. Nell'esempio seguente, la variabile Variable1 ha un valore di. Value1

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

Per un esempio della JSON struttura della pipeline, vedereCrea una pipeline, fasi e azioni.

Per un tutorial con una variabile a livello di pipeline che viene passata al momento dell'esecuzione della pipeline, vedi. Tutorial: utilizzare le variabili a livello di pipeline

Nota che l'utilizzo di variabili a livello di pipeline in qualsiasi tipo di azione Source non è supportato.

Configurazione delle variabili a livello di azione

È possibile configurare un'azione per produrre variabili dichiarando uno spazio dei nomi per l'azione. L'azione deve essere già uno dei provider di azioni che genera variabili. In caso contrario, le variabili disponibili sono variabili a livello di pipeline.

Dichiari lo spazio dei nomi da:

In questo esempio, aggiungete il namespace parametro all'azione di CodeCommit origine con il nome. SourceVariables In questo modo viene configurata l'azione per produrre le variabili disponibili per tale provider di azioni, ad esempio 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
        }
    ]
},

Successivamente, è possibile configurare l'azione downstream per utilizzare le variabili prodotte dall'azione precedente. Lo puoi fare procedendo come segue:

In questo esempio, il campo di configurazione dell'azione di compilazione mostra le variabili di ambiente che vengono aggiornate all'esecuzione dell'azione. L'esempio specifica lo spazio dei nomi e la variabile per l'ID di esecuzione con #{codepipeline.PipelineExecutionId} e lo spazio dei nomi e la variabile per l'ID commit con #{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
        }
    ]
},

Risoluzione delle variabili

Ogni volta che un'azione viene eseguita come parte di un'esecuzione di una pipeline, le variabili che produce sono disponibili per l'uso in qualsiasi azione che è garantita che si verifichi dopo l'azione di produzione. Per utilizzare queste variabili in un'azione consuming, è possibile aggiungerle alla configurazione dell'azione consuming utilizzando la sintassi mostrata nell'esempio precedente. Prima di eseguire un'azione di consumo, CodePipeline risolve tutti i riferimenti alle variabili presenti nella configurazione prima di iniziare l'esecuzione dell'azione.

Regole per le variabili

Le seguenti regole consentono di configurare le variabili:

Variabili disponibili per le operazioni della pipeline

Il provider di azioni determina quali variabili possono essere generate dall'azione.

Per step-by-step le procedure per la gestione delle variabili, vedere. Utilizzo delle variabili

Azioni con chiavi variabili definite

A differenza di uno spazio dei nomi che puoi scegliere, le azioni seguenti utilizzano chiavi variabili che non possono essere modificate. Ad esempio, per il provider di azioni Amazon S3, sono disponibili solo le chiavi ETag e VersionId variabili.

Ogni esecuzione ha anche un set di variabili CodePipeline di pipeline generate che contengono dati sull'esecuzione, come l'ID di rilascio della pipeline. Queste variabili possono essere consumate da qualsiasi azione nella pipeline.

CodePipeline variabile ID di esecuzione

Variabili di output delle ECR azioni Amazon

AWS CloudFormation StackSets variabili di output delle azioni

CodeCommit variabili di output dell'azione

CodeStarSourceConnection variabili di output delle azioni

GitHub variabili di output delle azioni (GitHub azione versione 1)

Variabili di output delle azioni S3

Azioni con chiavi variabili configurate dall'utente

Per CodeBuild le AWS CloudFormation azioni e Lambda, le chiavi variabili sono configurate dall'utente.

CloudFormation azioni (variabili di output)

CodeBuild azioni (variabili di output)

#{BuildVariables.EnvVar}

Variabili di output dell'azione Lambda