CodeBuild 规则

创建条件时，可以添加 CodeBuild 规则。本节提供对规则参数的参考。有关规则和条件的更多信息，请参阅阶段条件是如何运作的？。

您可以使用该 CodeBuild 规则来创建条件，使生成项目的成功运行符合规则标准，例如 beforeEntry 条件的构建运行成功。

注意

对于使用 “跳过” 结果配置的 beforeEntry 条件，只有以下规则可用：LambdaInvoke和VariableCheck。

服务角色策略权限

要获得此规则的权限，请在您的 CodePipeline 服务角色策略声明中添加以下内容。将权限范围缩小到资源级别。

{
    "Effect": "Allow",
    "Action": [
        "codebuild:BatchGetBuilds",
        "codebuild:StartBuild"
    ],
    "Resource": "resource_ARN"
},

Rule type

• 类别：Rule

• 拥有者：AWS

• 提供方：CodeBuild

• 版本：1

配置参数

ProjectName

必需：是

ProjectName是中构建项目的名称 CodeBuild。

PrimarySource

必需：条件

PrimarySource参数的值必须是操作的其中一个输入项目的名称。 CodeBuild 查找 buildspec 文件并在包含此工件解压缩版本的目录中运行 buildspec 命令。

如果为一个 CodeBuild 操作指定了多个输入构件，则此参数是必需的。当操作仅有一个源构件时，PrimarySource 构件默认为该构件。

BatchEnabled

必需：否

BatchEnabled 参数的布尔值允许操作在同一个构建执行中运行多个构建。

启用此选项后，CombineArtifacts 选项将变为可用。

有关启用批量构建的管道示例，请参阅CodePipeline 集成 CodeBuild 和批量构建。

CombineArtifacts

必需：否

CombineArtifacts 参数的布尔值将来自一个批量构建的所有构建构件合并为单个构件文件，将其用于构建操作。

要使用此选项，必须启用 BatchEnabled 参数。

EnvironmentVariables

必需：否

此参数的值用于为管道中的 CodeBuild 操作设置环境变量。EnvironmentVariables 参数的值采用环境变量对象的 JSON 数组形式。请参阅操作声明（CodeBuild 示例）中的示例参数。

每个对象有三个均为字符串的部分：

• name：环境变量的名称或键。

• value：环境变量的值。使用PARAMETER_STORE或SECRETS_MANAGER类型时，此值必须分别是您已经存储在 Sy AWS stems Manager 参数存储中的参数的名称或已经存储在 Secrets Manager 中的 AWS 密钥。

  注意

  我们强烈不鼓励使用环境变量来存储敏感值，尤其是 AWS 证书。使用 CodeBuild 控制台或 AWS CLI 时，环境变量将以纯文本形式显示。对于敏感值，我们建议您改用 SECRETS_MANAGER 类型。

• type：（可选）环境变量的类型。有效值为 PARAMETER_STORE、SECRETS_MANAGER 或 PLAINTEXT。如果未指定，则此值默认为 PLAINTEXT。

注意

type为环境变量配置输入namevalue、和时，尤其是在环境变量包含 CodePipeline 输出变量语法的情况下，请不要超过配置值字段的 1000 个字符限制。如果超过此限制，将会返回验证错误。

有关更多信息，请参阅 AWS CodeBuild API 参考 EnvironmentVariable中的。有关带有可解析为 GitHub 分支名称的环境变量的 CodeBuild 操作示例，请参阅示例：将 BranchName变量与 CodeBuild 环境变量一起使用。

规则配置示例

YAML

name: codebuild-rule
ruleTypeId:
  category: Rule
  owner: AWS
  provider: CodeBuild
  version: '1'
configuration:
  ProjectName: my-buildproject
  EnvironmentVariables: '[{"name":"VAR1","value":"variable","type":"PLAINTEXT"}]'
inputArtifacts:
- name: SourceArtifact
region: us-east-1

JSON

{
    "name": "codebuild-rule",
    "ruleTypeId": {
        "category": "Rule",
        "owner": "AWS",
        "provider": "CodeBuild",
        "version": "1"
    },
    "configuration": {
        "ProjectName": "my-buildproject"
    },
    "inputArtifacts": [
        {
            "name": "SourceArtifact",
            "EnvironmentVariables": "[{\"name\":\"VAR1\",\"value\":\"variable\",\"type\":\"PLAINTEXT\"}]"
        }
    ],
    "region": "us-east-1"
}

另请参阅

以下相关资源可在您使用此规则时为您提供帮助。

• 有关规则和条件的更多信息，请参阅 CodePipeline API 指南RuleExecution中的条件和。RuleTypeId