AWS CloudFormation
用户指南 (API 版本 2010-05-15)

AWS CodeBuild Project Environment

EnvironmentAWS::CodeBuild::Project 资源的一个属性,它为 AWS CodeBuild 项目指定环境。

语法

要在 AWS CloudFormation 模板中声明此实体,请使用以下语法:

JSON

{ "Certificate" : String, "ComputeType" : String, "EnvironmentVariables" : [ EnvironmentVariable ], "Image" : String, "ImagePullCredentialsType" : String, "PrivilegedMode" : Boolean, "RegistryCredential" : RegistryCredential, "Type" : String }

属性

Certificate

要用于构建项目的证书。

Required: No

Type: String

ComputeType

计算环境的类型,如 BUILD_GENERAL1_SMALL。计算类型决定了构建环境使用的 CPU 核心和内存数。有关有效值,请参阅 AWS CodeBuild 用户指南 中的 computeType 字段。

Required: Yes

Type: String

EnvironmentVariables

您的构建可以使用的环境变量。有关更多信息,请参阅 AWS CodeBuild 用户指南 中的 environmentVariables 字段。

Required: No

Type: EnvironmentVariable 列表

Image

标识 Docker 映像以用于此生成项目的映像标签或映像摘要。采用以下格式:

  • 对于映像标签:registry/repository:tag。例如,要用标签“latest”来指定一个映像,使用 registry/repository:latest

  • 对于映像摘要:registry/repository@digest。例如,要用摘要“sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf”指定一个映像,使用 registry/repository@sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf

有关更多信息,请参阅 AWS CodeBuild 用户指南 中的 image 字段。

Required: Yes

Type: String

ImagePullCredentialsType

用于在您的生成中拉取映像的凭证 AWS CodeBuild 的类型。有两个有效值:

  • CODEBUILD 指定 AWS CodeBuild 使用其自己的证书。这要求您修改您的 ECR 存储库策略以信任 AWS CodeBuild 服务委托人。

  • SERVICE_ROLE 指定 AWS CodeBuild 使用您的生成项目的服务角色。

当您使用跨账户或私有注册表映像时,必须使用 SERVICE_ROLE 凭证。当您使用 AWS CodeBuild 辅助映像时,必须使用 CODEBUILD 凭证。

构建环境使用的 Docker 映像标识符。有关更多信息,请参阅 AWS CodeBuild 用户指南 中的 imagePullCredentialsType 字段。

Required: Yes

Type: String

PrivilegedMode

指示项目如何生成 Docker 镜像。指定 true 以在 Docker 容器内支持运行的 Docker 守护程序。

只有在该构建项目用于构建 Docker 镜像,并且指定的构建环境映像不是由具有 Docker 支持的 AWS CodeBuild 提供时,才必须将该值设置为 true。否则,尝试与 Docker 守护程序交互的所有关联的构建都将失败。有关更多信息,请参阅 AWS CodeBuild 用户指南 中的 privilegedMode 字段。

Required: No

Type: Boolean

RegistryCredential

RegistryCredential 是指定有关提供私有 Docker 注册表访问权的凭证信息的 AWS::CodeBuild::Project 资源的一个属性。当设置此属性时:

  • imagePullCredentialsType 必须设置为 SERVICE_ROLE

  • 映像不能为辅助映像或 Amazon ECR 映像。

有关更多信息,请参阅 AWS CodeBuild 用户指南 中的 RegistryCredential 字段。

Required: No

类型RegistryCredential

Type

构建环境的类型。有关有效值,请参阅 AWS CodeBuild 用户指南 中的 environment-type 字段。

Required: Yes

Type: String

本页内容: