变量参考

本部分仅供参考。有关创建变量的信息，请参阅使用变量。

变量允许您使用在管道执行或操作执行时确定的值来配置管道操作。

一些操作提供方会生成一组定义的变量。您可以从该操作提供方的默认变量键中进行选择，例如提交 ID。

要查看使用变量的 step-by-step示例，请执行以下操作：

变量限制

有关限制信息，请参阅 中的配额 Amazon CodePipeline。

概念

此部分列出了与变量和命名空间相关的关键术语和概念。

Variables

变量是键/值对，可用于在管道中动态配置操作。目前，有三种方法提供这些变量：

要在操作配置中引用这些变量，您必须使用带有正确命名空间的变量引用语法。

有关示例变量工作流，请参阅配置变量 。

命名空间

为了确保可以唯一地引用该变量，必须将其分配到命名空间。将一组变量分配到命名空间后，您可以通过以下语法，使用命名空间和变量键在操作配置中引用这些变量：

#{namespace.variable_key}

您可以在三种类型的命名空间中分配变量：

变量使用案例

以下是管道级变量的一些常见使用案例，有助于确定如何根据自己的特定需求使用变量。

配置变量

您可以在管道级别或管道结构中的操作级别配置变量。

配置管道级变量

您可以添加一个或多个管道级变量。你可以在 CodePipeline 动作配置中引用这个值。您可以在创建管道时添加变量名称、默认值和描述。在执行时解析变量。

您可以使用管道结构中的变量属性提供管道级变量。在以下示例中，变量 Variable1 的值为 Value1。

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

有关管道JSON结构的示例，请参见创建管道、阶段和操作。

有关在管道执行时传递的管道级变量的教程，请参阅教程：使用管道级变量。

请注意，不支持在任何类型的源操作中使用管道级变量。

配置操作级变量

您可以通过为操作声明命名空间来配置操作以生成变量。该操作必须已经是生成变量的操作提供方之一。否则，可用的变量将为管道级别的变量。

您可以通过以下方法声明命名空间：

在此示例中，您将名称为的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
        }
    ]
},

接下来，您需要配置下游操作来使用由上一个操作生成的变量。您可以通过以下方法执行此操作：

在此示例中，构建操作的配置字段显示在操作执行时更新的环境变量。该示例为执行 ID #{codepipeline.PipelineExecutionId} 指定命名空间和变量，并为提交 ID #{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
        }
    ]
},

变量解析

每当在管道执行中执行某个操作时，该操作生成的变量均可用于确保在该操作之后运行的操作。要在使用操作中使用这些变量，您可以使用前面示例中显示的语法，将变量添加到使用操作的配置中。在它执行消耗操作之前，先 CodePipeline 解析配置中存在的所有变量引用，然后再启动动作执行。

变量规则

以下规则可帮助您进行变量的配置：

可用于管道操作的变量

操作提供方确定操作可以生成哪些变量。

有关管理变量的 step-by-step过程，请参见使用变量。

使用已定义变量键的操作

与可选择的命名空间不同，以下操作使用无法编辑的变量键。例如，对于 Amazon S3 操作提供方，只有 ETag 和 VersionId 变量键可用。

每次执行还具有一组 CodePipeline生成的管道变量，其中包含有关执行的数据，例如管道版本 ID。管道中的任何操作都可以使用这些变量。

CodePipeline 执行 ID 变量

Amazon ECR 操作输出变量

Amazon CloudFormation StackSets 操作输出变量

CodeCommit 操作输出变量

CodeStarSourceConnection 操作输出变量

GitHub 操作输出变量（GitHub 操作版本 1）

S3 操作输出变量

使用用户配置的变量键的操作

对于 CodeBuild Amazon CloudFormation、和 Lambda 操作，变量键由用户配置。

CloudFormation 操作输出变量

CodeBuild 操作输出变量

#{BuildVariables.EnvVar}

Lambda 操作输出变量