community.aws.codebuild_project 模块 – 创建或删除 AWS CodeBuild 项目

注意

此模块是 community.aws 集合（版本 9.0.0）的一部分。

如果您正在使用 ansible 包，则可能已经安装了此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用： ansible-galaxy collection install community.aws。您需要进一步的要求才能使用此模块，请参阅 要求 了解详细信息。

要在 playbook 中使用它，请指定： community.aws.codebuild_project。

community.aws 1.0.0 中的新增功能

概要

• 在 AWS 上创建或删除 CodeBuild 项目，用于从源代码构建代码构件。

• 在 5.0.0 版本之前，此模块名为 community.aws.aws_codebuild。用法没有改变。

别名：aws_codebuild

要求

执行此模块的主机上需要以下要求。

• python >= 3.6

• boto3 >= 1.28.0

• botocore >= 1.31.0

参数

参数	注释
access_key 别名：aws_access_key_id、aws_access_key、ec2_access_key 字符串	AWS 访问密钥 ID。 有关访问令牌的更多信息，请参阅 AWS 文档 https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys。 也可以按优先级降序使用 AWS_ACCESS_KEY_ID、AWS_ACCESS_KEY 或 EC2_ACCESS_KEY 环境变量。 aws_access_key 和 profile 选项是互斥的。 为了与 AWS botocore SDK 保持一致，在 5.1.0 版本中添加了 aws_access_key_id 别名。 ec2_access_key 别名已弃用，将在 2024-12-01 之后的版本中删除。 对 EC2_ACCESS_KEY 环境变量的支持已弃用，将在 2024-12-01 之后的版本中删除。
artifacts 字典	有关构建项目的构建输出构件的信息。 创建新项目时需要 artifacts。
location 字符串	有关构建输出构件位置的信息。当选择 type S3 时，在此处设置存储桶名称。
name 字符串	与 path 和 namespace_type 一起，AWS CodeBuild 将用来命名和存储输出构件的模式。
namespace_type 字符串	与 path 和 name 一起，AWS CodeBuild 将用来确定命名和存储输出构件位置的模式。 接受 BUILD_ID 和 NONE。 请参阅此处的文档： http://boto3.readthedocs.io/en/latest/reference/services/codebuild.html#CodeBuild.Client.create_project。
packaging 字符串	要在 S3 上创建的构建输出构件的类型，对于创建文件夹可以是 NONE，对于 ZIP 文件可以是 ZIP。
path 字符串	与 namespace_type 和 name 一起，AWS CodeBuild 将用来命名和存储输出构件的模式。 当类型为 S3 时，用于 S3 存储桶中的路径。
type 字符串 / 必需	构件的构建输出类型。可以是以下之一：CODEPIPELINE、NO_ARTIFACTS、S3。
aws_ca_bundle path	用于验证 SSL 证书的 CA 包的位置。 也可以使用 AWS_CA_BUNDLE 环境变量。
aws_config 字典	一个用于修改 botocore 配置的字典。 可以在 AWS 文档中找到参数 https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config。
cache 字典	缓存参数以加快后续构建速度。
location 字符串 / 必需	S3 上的缓存位置。
type 字符串 / 必需	缓存类型。可以是 NO_CACHE 或 S3。
debug_botocore_endpoint_logs 布尔值	使用 botocore.endpoint 记录器解析任务期间进行的唯一（而不是总计）"资源:操作" API 调用，将集合输出到任务结果中的 resource_actions 键。使用 aws_resource_action 回调输出到 playbook 期间生成的完整列表。 也可以使用 ANSIBLE_DEBUG_BOTOCORE_LOGS 环境变量。 选项 false ← (默认) true
description 字符串	CodeBuild 项目的描述性文本。
encryption_key 字符串	用于加密构建输出构件的 AWS Key Management Service (AWS KMS) 客户主密钥 (CMK)。
endpoint_url 别名: ec2_url, aws_endpoint_url, s3_url 字符串	用于连接的 URL，而不是默认的 AWS 端点。虽然这可以用于连接其他 AWS 兼容服务，但 amazon.aws 和 community.aws 集合仅针对 AWS 进行了测试。 也可以使用 AWS_URL 或 EC2_URL 环境变量，优先级递减。 ec2_url 和 s3_url 别名已被弃用，将在 2024-12-01 之后的版本中删除。 对 EC2_URL 环境变量的支持已被弃用，将在 2024-12-01 之后的版本中删除。
environment 字典	有关构建项目的构建环境的信息。
compute_type 字符串 / 必需	有关构建项目将使用的计算资源的信息。 可用值包括：BUILD_GENERAL1_SMALL, BUILD_GENERAL1_MEDIUM, BUILD_GENERAL1_LARGE。
environment_variables 字符串	一组环境变量，可用于构建项目的构建。包含 name 和 value 字段的字典列表。 示例：{ name: 'MY_ENV_VARIABLE', value: 'test' }
image 字符串 / 必需	用于此构建项目的 Docker 镜像的 ID。
privileged_mode 字符串	启用在 Docker 容器内运行 Docker 守护程序。 仅当构建项目用于构建 Docker 镜像时才设置为 true。
type 字符串 / 必需	用于项目的构建环境类型。通常为 LINUX_CONTAINER。
name 字符串 / 必需	CodeBuild 项目的名称。
profile 别名: aws_profile 字符串	用于身份验证的命名 AWS 配置文件。 有关命名配置文件的更多信息，请参阅 AWS 文档 https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html。 也可以使用 AWS_PROFILE 环境变量。 profile 选项与 aws_access_key、aws_secret_key 和 security_token 选项互斥。
purge_tags 布尔值	如果 purge_tags=true 且设置了 tags，则将从资源中清除现有标签，以完全匹配 tags 参数定义的标签。 如果未设置 tags 参数，则即使 purge_tags=True，也不会修改标签。 以 aws: 开头的标签键由 Amazon 保留，无法修改。因此，对于 purge_tags 参数，它们将被忽略。有关更多信息，请参阅 Amazon 文档 https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html#tag-conventions。 选项 false true ← (默认)
region 别名: aws_region, ec2_region 字符串	要使用的 AWS 区域。 对于 IAM、Route53 和 CloudFront 等全局服务，region 将被忽略。 也可以使用 AWS_REGION 或 EC2_REGION 环境变量。 有关更多信息，请参阅 Amazon AWS 文档 http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region。 ec2_region 别名已被弃用，将在 2024-12-01 之后的版本中删除 对 EC2_REGION 环境变量的支持已被弃用，将在 2024-12-01 之后的版本中删除。
secret_key 别名: aws_secret_access_key, aws_secret_key, ec2_secret_key 字符串	AWS 秘密访问密钥。 有关访问令牌的更多信息，请参阅 AWS 文档 https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys。 也可以按优先级递减的顺序使用 AWS_SECRET_ACCESS_KEY、AWS_SECRET_KEY 或 EC2_SECRET_KEY 环境变量。 secret_key 和 profile 选项互斥。 为了与 AWS botocore SDK 保持一致，在 5.1.0 版本中添加了 aws_secret_access_key 别名。 ec2_secret_key 别名已被弃用，将在 2024-12-01 之后的版本中删除。 对 EC2_SECRET_KEY 环境变量的支持已被弃用，将在 2024-12-01 之后的版本中删除。
service_role 字符串	AWS IAM 角色的 ARN，该角色使 AWS CodeBuild 能够代表 AWS 账户与依赖的 AWS 服务进行交互。
session_token 别名: aws_session_token, security_token, aws_security_token, access_token 字符串	用于临时凭证的 AWS STS 会话令牌。 有关访问令牌的更多信息，请参阅 AWS 文档 https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys。 也可以按优先级递减的顺序使用 AWS_SESSION_TOKEN、AWS_SECURITY_TOKEN 或 EC2_SECURITY_TOKEN 环境变量。 security_token 和 profile 选项互斥。 别名 aws_session_token 和 session_token 在 3.2.0 版本中添加，参数名称在 6.0.0 版本中从 security_token 重命名为 session_token。 security_token、aws_security_token 和 access_token 别名已被弃用，将在 2024-12-01 之后的版本中删除。 对 EC2_SECRET_KEY 和 AWS_SECURITY_TOKEN 环境变量的支持已被弃用，将在 2024-12-01 之后的版本中删除。
source 字典	配置构建输入源的服务和位置。 创建新项目时，需要 source。
buildspec 字符串	用于此构建项目中构建的构建规范声明。如果它是 CodeBuild 项目的一部分，则保留为空。
git_clone_depth 整数	使用 git 时，您可以在此处将克隆深度指定为整数。
insecure_ssl 布尔值	启用此标志以在连接到项目源代码时忽略 SSL 警告。 选项 false true
location 字符串	有关要构建的源代码位置的信息。对于 type CODEPIPELINE，不应指定位置。
type 字符串 / 必需	源类型。允许使用以下类型之一：CODECOMMIT、CODEPIPELINE、GITHUB、S3、BITBUCKET、GITHUB_ENTERPRISE。
state 字符串	创建或删除 CodeBuild 项目。 选项 "present" ← (默认) "absent"
tags 别名: resource_tags 字典	表示要应用于资源的标签的字典。 如果未设置 tags 参数，则不会修改标签。
timeout_in_minutes 整数	CodeBuild 应等待多长时间，直到超时任何未标记为完成的构建。 默认值: 60
validate_certs 布尔值	设置为 false 时，与 AWS API 通信时将不验证 SSL 证书。 强烈建议不要设置 validate_certs=false，作为替代方案，请考虑设置 aws_ca_bundle。 选项 false true ← (默认)
vpc_config 字典	VPC 配置使 AWS CodeBuild 能够访问 Amazon VPC 中的资源。

说明

注意

• 有关参数和返回值的详细信息，请参阅 http://boto3.readthedocs.io/en/latest/reference/services/codebuild.html。

• tags 在 6.0.0 版本中从 boto3 格式更改为标准字典格式。

• 警告： 对于模块，环境变量和配置文件是从 Ansible “host” 上下文读取的，而不是从 “controller” 上下文读取的。因此，可能需要将文件显式复制到 “host”。对于查找和连接插件，环境变量和配置文件是从 Ansible “controller” 上下文读取的，而不是从 “host” 上下文读取的。

• Ansible 使用的 AWS SDK (boto3) 也可能会从 Ansible “host” 上下文（通常是 ~/.aws/credentials）中的配置文件读取凭证和其他设置（例如区域）的默认值。有关更多信息，请参阅 https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html。

示例

# Note: These examples do not set authentication details, see the AWS Guide for details.

- community.aws.codebuild_project:
    name: my_project
    description: My nice little project
    service_role: "arn:aws:iam::123123:role/service-role/code-build-service-role"
    source:
      # Possible values: BITBUCKET, CODECOMMIT, CODEPIPELINE, GITHUB, S3
      type: CODEPIPELINE
      buildspec: ''
    artifacts:
      namespaceType: NONE
      packaging: NONE
      type: CODEPIPELINE
      name: my_project
    environment:
      computeType: BUILD_GENERAL1_SMALL
      privilegedMode: "true"
      image: "aws/codebuild/docker:17.09.0"
      type: LINUX_CONTAINER
      environmentVariables:
        - name: 'PROFILE'
          value: 'staging'
    encryption_key: "arn:aws:kms:us-east-1:123123:alias/aws/s3"
    region: us-east-1
    state: present

返回值

常见返回值记录在此处，以下是此模块特有的字段

键	描述
project 复杂	返回描述代码项目配置的字典。 返回值: 成功
arn 字符串	CodeBuild 项目的 ARN。 返回值: 总是 示例: "arn:aws:codebuild:us-east-1:123123123:project/vod-api-app-builder"
artifacts 复杂	有关构建工件输出的信息 返回值: 总是
location 字符串	构建工件的输出位置。 返回值: 配置时
type 字符串	构建工件的类型。 返回值: 总是 示例: "CODEPIPELINE"
cache 字典	构建项目的缓存设置。 返回值: 配置时
created 字符串	项目创建时间的 时间戳。 返回值: 总是 示例: "2018-04-17T16:56:03.245000+02:00"
description 字符串	CodeBuild 项目的描述。 返回值: 总是 示例: "我的 不错 小 项目"
environment 字典	构建的环境设置。 返回值: 总是
name 字符串	CodeBuild 项目的名称。 返回值: 总是 示例: "my_project"
reource_tags 字典 在 community.aws 4.0.0 中添加	一个简单的字典，表示添加到项目的标签。 tags 和 reource_tags 以不同的格式表示相同的信息。 返回值: 配置时
service_role 字符串	在构建期间用于访问其他 AWS 服务的 IAM 角色。 返回值: 总是 示例: "arn:aws:iam::123123123:role/codebuild-service-role"
source 复杂	有关构建输入源代码的信息。 返回值: 总是
auth 复杂	关于 AWS CodeBuild 用于访问要构建的源代码的授权设置的信息。 返回值: 配置时
build_spec 字符串	用于此构建项目中的构建的构建规范声明。 返回值: 总是
git_clone_depth 整数	git 克隆深度。 返回值: 配置时
insecure_ssl 布尔值	如果设置为忽略 SSL 警告，则为 True。 返回值: 配置时
location 字符串	位置标识符，取决于源类型。 返回值: 配置时
type 字符串	存储库的类型。 返回值: 总是 示例: "CODEPIPELINE"
tags list / 元素=string	以 boto3 字典列表格式添加到项目的标签。 tags 和 reource_tags 以不同的格式表示相同的信息。 返回值: 配置时
timeout_in_minutes 整数	构建的超时时间（分钟）。 返回值: 总是 示例: 60

作者

• Stefan Horning (@stefanhorning)

集合链接

• 问题跟踪器
• 存储库（源代码）
• 交流