變數參考

本節僅供參考。如需有關建立變數的資訊，請參閱使用變數。

變數可讓您使用管線執行或動作執行時決定的值來設定管線動作。

某些動作提供者會產生一組已定義的變數。您可以從該動作提供者的預設變數索引鍵中選擇，例如遞交 ID。

若要查看 step-by-step 使用變數的範例：

變數限制

如需限制資訊，請參閱 配額 AWS CodePipeline。

概念

本節列出與變數和命名空間相關的主要術語和概念。

Variables

變數是鍵值組，可用來動態設定管道中的動作。目前有三種方式可以使用這些變數：

若要在動作組態中參考這些變數，您必須使用具有正確命名空間的變數參考語法。

如需變數工作流程範例，請參閱設定變數 。

命名空間

為了確保可唯一參考變數，必須將變數指派到一個命名空間。將一組變數指派到命名空間之後，即可在動作組態中使用命名空間和變數索引鍵來參考變數，語法如下：

#{namespace.variable_key}

有三種類型的命名空間下，可以分配變量：

變數的使用案例

以下是管線層級變數的一些最常見使用案例，可協助您判斷如何針對特定需求使用變數。

設定變數

您可以在配管層級或配管結構中的動作層級配置變數。

在管線層級配置變數

您可以在配管層級新增一或多個變數。您可以在 CodePipeline 動作的組態中參照此值。您可以在建立配管時新增變數名稱、預設值和說明。變量在執行時解析。

您可以使用配管結構中的 variable 屬性在管線層級提供變數。在下列範例中，Variable1變數的值為Value1。

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

如需配管JSON結構中的範例，請參閱建立管道、階段和動作。

如需在管線執行時傳送的管線層級變數的教學課程，請參閱。教學課程：使用管線層級變數

請注意，不支援在任何類型的 Source 動作中使用管線層級變數。

在動作層級配置變數

您可以宣告動作的命名空間，以設定動作來產生變數。動作必須已經是產生變數的動作提供者之一。否則，可用的變數是管道層級的變數。

您可以透過以下方式宣告命名空間：

在此範例中，您可以使用名稱將namespace參數加入至 CodeCommit 來源動作SourceVariables。這會設定動作來產生可供該動作提供者使用的變數，例如 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
        }
    ]
},

接下來，您將下游動作設定為使用先前動作所產生的變數。作法如下：

在此範例中，建置動作的組態欄位顯示動作執行時更新的環境變數。此範例以 #{codepipeline.PipelineExecutionId} 指定執行 ID 的命名空間和變數，以 #{SourceVariables.CommitId} 指定遞交 ID 的命名空間和變數。

{
    "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
        }
    ]
},

變數解析

每次在管道執行中執行動作時，它產生的變數可用於產生動作之後保證發生的任何動作中。若要在取用動作中使用這些變數，您可以使用上一個範例所示的語法，將這些變數新增至取用動作的組態。在執行消費動作之前，請先 CodePipeline 解析組態中存在的所有變數參照，然後再啟動動作執行。

變數的規則

下列規則可協助您設定變數：

管道動作可用的變數

動作提供者決定哪些變數可以由動作產生。

如需管理變數的 step-by-step 程序，請參閱使用變數。

具有已定義變數鍵的動作

與您可以選擇的命名空間不同，下列動作使用無法編輯的變數索引鍵。例如，對於 Amazon S3 動作提供者，只有ETag和可VersionId變金鑰可用。

每個執行也有一組 CodePipeline產生的管線變數，其中包含執行相關資料，例如管線發行 ID。管道中的任何動作都可以取用這些變數。

CodePipeline執行 ID 變數

Amazon ECR 動作輸出變量

AWS CloudFormation StackSets 動作輸出變數

CodeCommit 動作輸出變數

CodeStarSourceConnection 動作輸出變數

GitHub 動作輸出變數 (GitHub 動作版本 1)

S3 動作輸出變數

使用使用者設定之變數金鑰的

對於 CodeBuild AWS CloudFormation、和 Lambda 動作而言，變數金鑰是由使用者設定的。

CloudFormation 動作輸出變數

CodeBuild 動作輸出變數

#{BuildVariables.EnvVar}

動 Lambda 輸出變數