本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。
AwsCodeBuildProject
AwsCodeBuildProject
对象提供有关 Amazon CodeBuild 项目的信息。
示例
"AwsCodeBuildProject": { "EncryptionKey": "my-symm-key", "Environment": { "Type": "LINUX_CONTAINER", "Certificate": "myX509", "ImagePullCredentialsType": "CODEBUILD", "RegistryCredential": { "Credential": "my_dockerhub_secret", "CredentialProvider": "SECRETS_MANAGER" } }, "Name": "my-cd-project", "Source": { "Type": "CODECOMMIT", "Location": "https://git-codecommit.us-east-2.amazonaws.com/v1/repos/MyDemoRepo", "GitCloneDepth": 1 }, "ServiceRole": "arn:aws:iam:myrole", "VpcConfig": { "VpcId": "vpc-1234456", "Subnets": ["sub-12344566"], "SecurityGroupIds": ["sg-123456789012"] } }
目录
AwsCodeBuildProject 属性
AwsCodeBuildProject
对象可能具有以下属性。
- Artifacts
-
可选
有关 CodeBuild 项目的构建工件的信息。
类型:对象数组
最小数组长度:1
最大阵列长度:25
EncryptionKey
-
可选
这些区域有:Amazon KMS key用于加密构建输出构件。
注意 如果您的服务角色具有一个跨账户 KMS 密钥的权限,则您可使用此密钥来加密构建输出构件。
可以使用格式指定 KMS 密钥的 ARN,也可以使用格式指定 KMS 密钥别名(如果可用)。
化名
/别名
)。类型: 字符串
最小长度:1
- Environment
-
可选
有关该构建项目的构建环境的信息。
类型:对象
- LogsConfig
-
可选
有关构建项目的日志的信息。
类型:对象
Name
-
可选
构建项目的名称。
类型:字符串
最小长度:2
最大长度:255
模式:[A-Za-Za-Za-Za-Za-Za-za-za-za-za-za-za-za-za-za-za-za-za-za-za-za-
ServiceRole
-
可选
允许 CodeBuild 与依赖项进行交互的 IAM 角色的 ARNAmazon代表Amazonaccount.
类型:字符串
最小长度:1
- Source
-
可选
有关此构建项目的构建输入源代码的信息。
类型:对象
- VpcConfig
-
可选
有关 CodeBuild 访问的 VPC 配置的信息。
类型:对象
Artifacts
这些区域有:Artifacts
对象提供有关 CodeBuild 项目的构建项目的信息。
每个项目定义可能具有以下属性。
ArtifactIdentifier
-
可选
构件定义的标识符。
类型:字符串
EncryptionDisabled
-
可选
指示是否禁用对工件的加密。只有当时才有效
Type
是S3
.类型:Boolean
Location
-
可选
仅在
Type
为S3
时使用。构件所在的 S3 存储桶的名称。类型:字符串
Name
-
可选
仅在
Type
为S3
时使用。构件的名称。与使用NamepaceType
和Path
以确定存储工件的模式。类型:字符串
NamespaceType
-
可选
仅在
Type
为S3
时使用。要用于命名空间的值。与使用Name
和Path
以确定存储工件的模式。类型:字符串
有效值:
NONE
|BUILD_ID
OverrideArtifactName
-
可选
在 buildspec 文件中指定的名称是否覆盖构件名称。
类型:Boolean
Packaging
-
可选
仅在
Type
为S3
时使用。要创建的输出项目的类型。类型:字符串
有效值:
NONE
|ZIP
Path
-
可选
仅在
Type
为S3
时使用。通往神器的路径。与使用Name
和NamespaceType
以确定存储工件的模式。类型:字符串
Type
-
可选
构建构件的类型。
类型:字符串
有效值:
CODEPIPELINE
|S3
|NO_ARTIFACTS
Environment
Environment
对象提供有关构建项目的构建环境的信息。
它可能具有以下属性。
Certificate
-
可选
要用于此构建项目的证书。
类型:字符串
- EnvironmentVariables
-
可选
要提供给构建项目的构建操作的一组环境变量。
类型:对象数组
最大阵列长度:5
ImagePullCredentialsType
-
可选
CodeBuild 用于在您的生成中拉取映像的凭证的类型。有两个有效值:
CODEBUILD
指定 CodeBuild 使用其自己的凭证。这要求您修改 ECR 存储库策略以信任 CodeBuild 服务委托人。SERVICE_ROLE
指定 CodeBuild 使用您的构建项目的服务角色。当您使用跨账户或专用镜像仓库镜像时,必须使用
SERVICE_ROLE
凭证。当您使用 CodeBuild 精选映像时,必须使用CODEBUILD
凭证。类型:字符串
有效值:
CODEBUILD
|SERVICE_ROLE
PrivilegedMode
-
可选
是否允许 Docker 守护程序在 Docker 容器内运行。如果构建项目用于构建 Docker 映像,则设置为 true。
类型:Boolean
RegistryCredential
-
可选
用于访问私有注册表的凭证。
类型:对象
Type
-
必填
要用于相关构建的构建环境的类型。
类型:字符串
有效值:
WINDOWS_CONTAINER
|LINUX_CONTAINER
|LINUX_GPU_CONTAINER
|ARM_CONTAINER
RegistryCredentials
对象中的每个注册表凭证具有以下属性。
Credential
-
必填
使用 Amazon Secrets Manager 创建的凭证的 ARN 或名称。
注意 仅当凭证存在于您的当前凭证中时,才能使用凭证的名称。Amazon区域。
类型:字符串
最小长度:1
CredentialProvider
-
必填
创建访问私有 Docker 注册表凭证的服务。有效值,
SECRETS_MANAGER
,是针对 Secrets Manager 的。类型:字符串
有效值:
SECRETS_MANAGER
EnvironmentVariables
这些区域有:EnvironmentVariables
对象提供有关可用于构建项目的环境变量的信息。
每个环境变量可能具有以下属性。
Name
-
可选
环境变量的名称。
类型:字符串
Type
-
可选
环境变量的类型。
类型:字符串
有效值:
PLAINTEXT
|PARAMETER_STORE
|SECRETS_MANAGER
Value
-
可选
环境变量的值。
类型:字符串
LogsConfig
这些区域有:LogsConfig
对象包含有关构建项目的日志的信息。
LogsConfig
可能具有以下属性。
- CloudWatchLogs
-
可选
有关构建项目的 CloudWatch Logs 的信息。
类型:对象
- S3Logs
-
可选
有关在构建项目的 S3 存储桶中生成的日志的信息。
类型:对象
CloudWatchLogs
这些区域有:CloudWatchLogs
对象包含有关构建项目的 CloudWatch Logs 的信息。
CloudWatchLogs
可能具有以下属性。
GroupName
-
可选
CloudWatch Logs 中的日志的组名称。
类型:字符串
Status
-
可选
构建项目的 CloudWatch Logs 中的日志的当前状态。
类型:字符串
有效值:
ENABLED
|DISABLED
StreamName
-
可选
CloudWatch Logs 的流名称的前缀。
类型:字符串
S3Logs
这些区域有:S3Logs
对象包含有关在构建项目的 S3 存储桶中生成的日志的信息。
S3Logs
可能具有以下属性。
EncryptionDisabled
-
可选
是否禁用 S3 构建日志输出的加密。
类型:Boolean
Location
-
可选
S3 日志 S3 存储桶的 ARN 和路径前缀。
类型:字符串
Status
-
可选
S3 构建日志的当前状态。
类型:字符串
有效值:
ENABLED
|DISABLED
Source
Source
对象提供有关该构建项目的构建输入源代码的信息。
它可能具有以下属性。
GitCloneDepth
-
可选
有关构建项目的 Git 克隆深度的信息。
类型:整数
最小值 0
Location
-
可选
有关要生成的源代码的位置的信息。
类型:字符串
有效值:
-
对于在 Amazon CodePipeline 中的管道的源操作中指定的源代码设置,不应指定
location
。如果指定该值,CodePipeline 将其忽略。这是因为 CodePipeline 使用管道的源操作中的设置而不是该值。 -
对于中的源代码Amazon CodeCommit存储库,则为指向包含源代码和构建规范文件的存储库的 HTTPS 克隆 URL(例如,
https://git-codecommit.region-ID.amazonaws.com/v1/repos/repo-name
)。 -
对于 S3 输入存储桶中的源代码,这是以下内容之一。
-
最大的路径
.zip
包含源代码的文件(例如,bucket-name/path/to/object-name.zip
)。 -
包含源代码的文件夹的路径(例如,
bucket-name/path/to/source-code/folder/
)。
-
-
对于 GitHub 存储库中的源代码,则为指向包含源和构建规范文件的存储库的 HTTPS 克隆 URL。
-
对于 Bitbucket 存储库中的源代码,则为指向包含源和构建规范文件的存储库的 HTTPS 克隆 URL。
-
Type
-
必填
包含要构建的源代码的存储库的类型。
类型:字符串
有效值:
-
BITBUCKET
-源代码位于 Bitbucket 存储库中。CODECOMMIT
‐源代码位于 CodeCommit 存储库中。CODEPIPELINE
‐源代码设置是在 CodePipeline 中管道的源操作中指定的。GITHUB
‐源代码位于 GitHub 存储库中。GITHUB_ENTERPRISE
-源代码位于 GitHub Enterprise 存储库中。NO_SOURCE
-项目没有输入源代码。S3
‐源代码位于 Amazon S3 输入存储桶中。
-
VpcConfig
这些区域有:VpcConfig
对象提供有关 CodeBuild 访问的 VPC 配置的信息。
它可能具有以下属性。
SecurityGroupIds
-
可选
Amazon VPC 中的一个或多个安全组 ID 的列表。
类型:字符串数组
数组成员:最多 5 项
每件商品的最小长度:1
Subnets
-
可选
Amazon VPC 中的一个或多个子网 ID 的列表。
类型:字符串数组
字符串的最大数量:16
每件商品的最小长度:1
VpcId
-
可选
VPC 的 ID。
类型:字符串
最小长度:1