變數參考

PDF

RSS

焦點模式

變數參考 - AWS CodePipeline

概念變數的使用案例設定變數變數解析變數的規則管道動作可用的變數

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

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

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

重要

傳遞秘密參數時，請勿直接輸入值。此值渲染為純文字，因此為可讀取。基於安全考量，請勿將純文字與秘密搭配使用。我們強烈建議您使用 AWS Secrets Manager 來存放秘密。

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

如需在管道執行時傳遞之管道層級變數的教學課程，請參閱教學課程：使用管道層級變數。
如需使用上游動作 (CodeCommit) 變數並產生輸出變數的 Lambda 動作教學課程，請參閱教學課程：搭配 Lambda 叫用動作使用變數。
如需從上游 CloudFormation AWS CloudFormation 動作參考堆疊輸出變數之動作的教學課程，請參閱教學課程：建立使用 AWS CloudFormation 部署動作變數的管道。
如需手動核准動作範例，其中包含參考解析為 CodeCommit 遞交 ID 和遞交訊息之輸出變數的訊息文字，請參閱範例：在手動核准中使用變數。
如需具有解析為 GitHub 分支名稱之環境變數的 CodeBuild 動作範例，請參閱範例：搭配 CodeBuild 環境變數使用 BranchName 變數。
CodeBuild 動作會產生做為變數的所有環境變數，這些變數是做為組建的一部分匯出。如需詳細資訊，請參閱CodeBuild 動作輸出變數。

變數限制

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

注意

當您在動作組態欄位中輸入變數語法時，請勿超過組態欄位的 1000 個字元限制。如果超過此限制，系統就會傳回驗證錯誤。

概念

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

Variables

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

每個管線執行開始時有一組隱含可用的變數。這組變數目前包括 PipelineExecutionId (目前管道執行的 ID)。
管道層級的變數會在管道執行時間建立和解析管道時定義。

您可以在建立管道時指定管道層級變數，並在管道執行時提供值。
某些動作類型在執行時產生一組變數。您可以檢查 ListActionExecutions API 中的 outputVariables 欄位，以查看動作產生的變數。如需各動作提供者的可用索引鍵名稱的清單，請參閱管道動作可用的變數。若要查看每個動作類型產生的變數，請參閱 CodePipeline 動作結構參考。

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

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

命名空間

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


#{namespace.variable_key}

可以指派變數的命名空間有三種類型：

CodePipeline 保留的命名空間

這是指派給每個管道執行開始時可用的隱含變數集的命名空間。這個命名空間是 codepipeline。變數參考範例：
```
#{codepipeline.PipelineExecutionId}
```
管道層級的變數命名空間

這是指派給管道層級變數的命名空間。管道層級所有變數的命名空間為 variables。變數參考範例：
```
#{variables.variable_name}
```
動作指派的命名空間

這是您指派給動作的命名空間。由動作產生的所有變數都屬於這個命名空間。若要讓動作所產生的變數可供下游動作組態中使用，您必須使用命名空間來設定產生動作。命名空間在整個管道定義中必須是唯一的，且不能與任何成品名稱衝突。以下是使用命名空間 SourceVariables 設定的動作的變數參考範例。
```
#{SourceVariables.VersionId}
```

變數的使用案例

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

管道層級的變數適用於希望每次使用相同管道的 CodePipeline 客戶，其動作組態的輸入會有些微變化。啟動管道的任何開發人員都會在管道啟動時，在 UI 中新增變數值。使用此組態，您只能傳遞該執行的參數。
使用管道層級變數，您可以將動態輸入傳遞至管道中的動作。您可以將參數化管道遷移至 CodePipeline，而無需維護相同管道的不同版本，或建立複雜的管道。
您可以使用管道層級變數來傳遞輸入參數，讓您在每次執行時重複使用管道，例如當您想要指定要部署到生產環境的版本時，因此您不需要重複管道。
您可以使用單一管道將資源部署到多個建置和部署環境。例如，對於具有 CodeCommit 儲存庫的管道，可以使用管道層級傳遞的 CodeBuild 和 CodeDeploy 參數，從指定的分支和目標部署環境進行部署。

注意

對於 Amazon ECR、Amazon S3 或 CodeCommit 來源，您也可以使用輸入轉換項目來建立來源覆寫，以將 EventBridge revisionValue中的用於管道事件，其中 revisionValue 衍生自物件金鑰、遞交或映像 ID 的來源事件變數。如需詳細資訊，請參閱 Amazon ECR 來源動作和 EventBridge 資源、連線至已啟用事件來源的 Amazon S3 來源動作或下程序中包含的輸入轉換項目選用步驟CodeCommit 來源動作和 EventBridge。

設定變數

您可以在管道層級或管道結構中的動作層級設定變數。

在管道層級設定變數

您可以在管道層級新增一或多個變數。您可以在 CodePipeline 動作的組態中參考此值。您可以在建立管道時新增變數名稱、預設值和描述。變數會在執行時解析。

注意

如果未在管道層級為變數定義預設值，則該變數會視為必要。當您啟動管道時，必須指定所有必要變數的覆寫，否則管道執行會失敗並出現驗證錯誤。

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


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

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

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

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

注意

如果variables命名空間已用於管道中的某些動作，您必須更新動作定義，並為衝突的動作選擇另一個命名空間。

在動作層級設定變數

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

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

在主控台的 Edit action (編輯動作) 頁面上，在 Variable namespace (變數命名空間) 中輸入命名空間。
在 JSON 管道結構的 namespace 參數欄位中輸入命名空間。

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

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

在主控台的 Edit action (編輯動作) 頁面上，在動作組態欄位中輸入變數語法 (針對下游動作)。
在 JSON 管道結構的動作組態欄位中輸入變數語法 (針對下游動作)

在此範例中，建置動作的組態欄位顯示動作執行時更新的環境變數。此範例以 #{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 會在啟動動作執行之前解決組態中存在的所有變數參考。

變數的規則

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

您可以透過新的動作屬性或編輯動作，指定動作的命名空間和變數。
當您使用管道建立精靈時，主控台會為精靈建立的每個動作產生命名空間。
如果未指定命名空間，則無法在任何動作組態中參考該動作產生的變數。
若要參考動作所產生的變數，參考動作必須在產生變數的動作之後發生。這意味著在比產生變數的動作更晚的階段，或在同一階段，但執行順序較高。

管道動作可用的變數

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

如需管理變數的逐步程序，請參閱使用變數。

具有已定義變數索引鍵的動作

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

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

主題

CodePipeline 執行 ID 變數
Amazon ECR 動作輸出變數
AWS CloudFormation StackSets 動作輸出變數
CodeCommit 動作輸出變數
CodeStarSourceConnection 動作輸出變數
GitHub 動作輸出變數 (GitHub （透過 OAuth 應用程式）動作）
S3 動作輸出變數

CodePipeline 執行 ID 變數

CodePipeline 執行 ID 變數
供應商	變數索引鍵	範例值	變數語法範例
codepipeline	`PipelineExecutionId`	8abc75f0-fbf8-4f4c-bfEXAMPLE	`#{codepipeline.PipelineExecutionId}`

Amazon ECR 動作輸出變數

Amazon ECR 變數
變數索引鍵	範例值	變數語法範例
`ImageDigest`	sha256:EXAMPLE1122334455	`#{SourceVariables.ImageDigest}`
`ImageTag`	最新	`#{SourceVariables.ImageTag}`
`ImageURI`	11111EXAMPLE.dkr.ecr.us-west-2.amazonaws.com/ecs-repo:latest	`#{SourceVariables.ImageURI}`
`RegistryId`	EXAMPLE12233	`#{SourceVariables.RegistryId}`
`RepositoryName`	my-image-repo	`#{SourceVariables.RepositoryName}`

AWS CloudFormation StackSets 動作輸出變數

AWS CloudFormation StackSets 變數
變數索引鍵	範例值	變數語法範例
`OperationId`	11111111-2bbb-111-2bbb-111111example	`#{DeployVariables.OperationId}`
`StackSetId`	my-stackset：1111aaaaaa-1111-2222-2bbb-111111example	`#{DeployVariables.StackSetId}`

CodeCommit 動作輸出變數

CodeCommit 變數
變數索引鍵	範例值	變數語法範例
`AuthorDate`	2019-10-29T03:32:21Z	`#{SourceVariables.AuthorDate}`
`BranchName`	開發	`#{SourceVariables.BranchName}`
`CommitId`	exampleb01f91b31	`#{SourceVariables.CommitId}`
`CommitMessage`	修正錯誤 (100 KB 大小上限)	`#{SourceVariables.CommitMessage}`
`CommitterDate`	2019-10-29T03:32:21Z	`#{SourceVariables.CommitterDate}`
`RepositoryName`	myCodeCommitRepo	`#{SourceVariables.RepositoryName}`

CodeStarSourceConnection 動作輸出變數

`CodeStarSourceConnection` 變數 (Bitbucket Cloud、GitHub、GitHub Enterprise Repository 和 GitLab.com)
變數索引鍵	範例值	變數語法範例
`AuthorDate`	2019-10-29T03:32:21Z	`#{SourceVariables.AuthorDate}`
`BranchName`	開發	`#{SourceVariables.BranchName}`
`CommitId`	exampleb01f91b31	`#{SourceVariables.CommitId}`
`CommitMessage`	修正錯誤 (100 KB 大小上限)	`#{SourceVariables.CommitMessage}`
`ConnectionArn`	arn：aws：codestar-connections：region：`account-id`：connection/`connection-id`	`#{SourceVariables.ConnectionArn}`
`FullRepositoryName`	username/GitHubRepo	`#{SourceVariables.FullRepositoryName}`

GitHub 動作輸出變數 (GitHub （透過 OAuth 應用程式）動作）

GitHub 變數 (GitHub （透過 OAuth 應用程式）動作）
變數索引鍵	範例值	變數語法範例
`AuthorDate`	2019-10-29T03:32:21Z	`#{SourceVariables.AuthorDate}`
`BranchName`	主要	`#{SourceVariables.BranchName}`
`CommitId`	exampleb01f91b31	`#{SourceVariables.CommitId}`
`CommitMessage`	修正錯誤 (100 KB 大小上限)	`#{SourceVariables.CommitMessage}`
`CommitterDate`	2019-10-29T03:32:21Z	`#{SourceVariables.CommitterDate}`
`CommitUrl`		`#{SourceVariables.CommitUrl}`
`RepositoryName`	myGitHubRepo	`#{SourceVariables.RepositoryName}`

S3 動作輸出變數

S3 變數
變數索引鍵	範例值	變數語法範例
`ETag`	example28be1c3	`#{SourceVariables.ETag}`
`VersionId`	exampleta_IUQCv	`#{SourceVariables.VersionId}`

使用使用者設定變數索引鍵的動作

對於 CodeBuild AWS CloudFormation和 Lambda 動作，變數索引鍵是由使用者設定。

主題

CloudFormation 動作輸出變數
CodeBuild 動作輸出變數
Lambda 動作輸出變數

CloudFormation 動作輸出變數

AWS CloudFormation 變數
變數索引鍵	變數語法範例
對於 AWS CloudFormation 動作，變數會從堆疊範本 `Outputs`區段中指定的任何值產生。請注意，產生輸出的唯一 CloudFormation 動作模式是造成堆疊建立或更新的模式，例如堆疊建立、堆疊更新和變更集執行。產生變數的相應動作模式如下： CREATE_UPDATE CHANGE_SET_EXECUTE CHANGE_SET_REPLACE REPLACE_ON_FAILURE 如需這些動作模式的詳細資訊，請參閱 AWS CloudFormation 部署動作參考。如需示範如何在使用 AWS CloudFormation 輸出變數的管道中使用 AWS CloudFormation 部署動作建立管道的教學課程，請參閱教學課程：建立使用 AWS CloudFormation 部署動作變數的管道。	`#{DeployVariables.StackName}`

CodeBuild 動作輸出變數

CodeBuild 變數
變數索引鍵	變數語法範例
對於 CodeBuild 動作，變數會從匯出環境變數所產生的值產生。在 CodePipeline 中編輯 CodeBuild 動作，或將CodePipeline 環境變數。 CodeBuild 將指示新增至 CodeBuild 建置規格，以在匯出的變數區段下新增環境變數。請參閱AWS CodeBuild 《使用者指南》中的 env/exported-variables。	`#{BuildVariables.EnvVar}`

Lambda 動作輸出變數

Lambda 變數
變數索引鍵	變數語法範例
Lambda 動作會以變數的形式產生包含在 PutJobSuccessResult API 請求的 `outputVariables`區段中的所有鍵值對。如需使用上游動作 (CodeCommit) 變數並產生輸出變數的 Lambda 動作教學課程，請參閱教學課程：搭配 Lambda 叫用動作使用變數。	`#{TestVariables.testRunId}`

您的瀏覽器已停用或無法使用 Javascript。

您必須啟用 Javascript，才能使用 AWS 文件。請參閱您的瀏覽器說明頁以取得說明。

文件慣用形式

映像定義檔案參考

使用語法中的 glob 模式

在本頁面

選取您的 Cookie 偏好設定