community.aws.codecommit_repository 模块 – 管理 AWS CodeCommit 中的仓库

注意

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

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

要安装它，请使用：ansible-galaxy collection install community.aws。您需要其他要求才能使用此模块，有关详细信息，请参阅 要求。

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

community.aws 1.0.0 中的新增功能

概要

• 支持创建和删除 CodeCommit 仓库。

• 有关 CodeCommit 的更多信息，请参阅 https://aws.amazon.com/codecommit/。

• 在 5.0.0 版本之前，此模块称为 community.aws.aws_codecommit。 使用方法没有改变。

别名：aws_codecommit

要求

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

• 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 之后的版本中删除。
aws_ca_bundle 路径	用于验证 SSL 证书的 CA 捆绑包的位置。 也可以使用 AWS_CA_BUNDLE 环境变量。
aws_config 字典	用于修改 botocore 配置的字典。 可以在 AWS 文档中找到参数 https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config。
debug_botocore_endpoint_logs 布尔值	使用 botocore.endpoint 记录器来解析任务期间进行的唯一（而不是总共）"resource:action" API 调用，将集合输出到任务结果中的 resource_actions 键。 使用 aws_resource_action 回调输出到 playbook 期间制作的列表总数。 也可以使用 ANSIBLE_DEBUG_BOTOCORE_LOGS 环境变量。 选项 false ← (默认) true
description 别名：comment 字符串	仓库的描述或注释。 默认： ""
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 之后的版本中移除。
名称 字符串 / 必需	仓库的名称。
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 选项互斥。
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 之后的版本中移除。
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 之后的版本中移除。
状态 字符串 / 必需	指定仓库的状态。 选项 “存在” “不存在”
validate_certs 布尔值	设置为 false 时，与 AWS API 通信时将不验证 SSL 证书。 强烈建议不要设置 validate_certs=false，作为替代方案，请考虑设置 aws_ca_bundle。 选项 false true ← (默认)

注释

注意

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

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

示例

# Create a new repository
- community.aws.codecommit_repository:
    name: repo
    state: present

# Delete a repository
- community.aws.codecommit_repository:
    name: repo
    state: absent

返回值

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

键	描述
repository_metadata 复杂	有关仓库的信息。 返回：始终
account_id 字符串	与仓库关联的 AWS 账户的 ID。 返回：当状态为存在时 示例： "123456789012"
arn 字符串	仓库的 Amazon 资源名称 (ARN)。 返回：当状态为存在时 示例： "arn:aws:codecommit:ap-northeast-1:123456789012:username"
clone_url_http 字符串	用于通过 HTTPS 克隆仓库的 URL。 返回：当状态为存在时 示例： "https://git-codecommit.ap-northeast-1.amazonaws.com/v1/repos/reponame"
clone_url_ssh 字符串	用于通过 SSH 克隆仓库的 URL。 返回：当状态为存在时 示例： "ssh://git-codecommit.ap-northeast-1.amazonaws.com/v1/repos/reponame"
creation_date 字符串	仓库创建的日期和时间，采用时间戳格式。 返回：当状态为存在时 示例： "2018-10-16T13:21:41.261000+09:00"
last_modified_date 字符串	仓库上次修改的日期和时间，采用时间戳格式。 返回：当状态为存在时 示例： "2018-10-16T13:21:41.261000+09:00"
repository_description 字符串	有关仓库的注释或描述。 返回：当状态为存在时 示例： "test from ptux"
repository_id 字符串	已创建或删除的仓库的 ID 返回：始终 示例： "e62a5c54-i879-497b-b62f-9f99e4ebfk8e"
repository_name 字符串	仓库的名称。 返回：当状态为存在时 示例： "reponame"
response_metadata 复杂	有关响应的信息。 返回：始终
http_headers 字典	http 响应的 http 标头 返回：始终
http_status_code 字符串	http 响应的 http 状态代码 返回：始终 示例： "200"
request_id 字符串	http 请求 ID 返回：始终 示例： "fb49cfca-d0fa-11e8-85cb-b3cc4b5045ef"
retry_attempts 字符串	重试尝试的次数 返回：始终 示例： "0"

作者

• Shuang Wang (@ptux)

集合链接

• 问题跟踪器
• 仓库（来源）
• 沟通