community.aws.batch_compute_environment 模块 – 管理 AWS Batch 计算环境

注意

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

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

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

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

community.aws 1.0.0 中的新增功能

概要

• 此模块允许管理 AWS Batch 计算环境。

• 它是幂等的，并支持“检查”模式。

• 使用模块 community.aws.batch_compute_environment 管理计算环境，community.aws.batch_job_queue 管理作业队列，community.aws.batch_job_definition 管理作业定义。

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

别名：aws_batch_compute_environment

要求

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

• 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。
bid_percentage 整数	与该实例类型的按需价格相比，Spot 实例价格必须达到多少最小百分比才能启动实例。 例如，如果您的竞价百分比为 20%，则 Spot 价格必须低于该 EC2 实例的当前按需价格的 20%。
compute_environment_name 字符串 / 必填	计算环境的名称。 最多允许 128 个字母（大写和小写）、数字和下划线。
compute_environment_state 字符串	计算环境的状态。 如果状态为 ENABLED，则计算环境接受来自队列的作业，并且可以根据队列自动扩展。 选项 "ENABLED" ← (默认) "DISABLED"
compute_resource_type 字符串 / 必填	计算资源的类型。 选项 "EC2" "SPOT"
debug_botocore_endpoint_logs 布尔值	使用 botocore.endpoint 记录器来解析在任务期间进行的唯一（而不是总计）"resource:action" API 调用，并将集合输出到任务结果中的 resource_actions 密钥。使用 aws_resource_action 回调将输出到 playbook 期间进行的总列表。 还可以使用 ANSIBLE_DEBUG_BOTOCORE_LOGS 环境变量。 选项 false ← (默认) true
desiredv_cpus 整数	计算环境中所需的 EC2 vCPU 数量。
ec2_key_pair 字符串	用于在计算环境中启动实例的 EC2 密钥对。
endpoint_url 别名：ec2_url, aws_endpoint_url, s3_url 字符串	连接到非默认 AWS 端点的 URL。虽然这可以用于连接到其他兼容 AWS 的服务，但 amazon.aws 和 community.aws 集合仅针对 AWS 进行测试。 也可以使用 AWS_URL 或 EC2_URL 环境变量，优先级依次递减。 ec2_url 和 s3_url 别名已弃用，将在 2024-12-01 之后的一个版本中移除。 EC2_URL 环境变量的支持已弃用，将在 2024-12-01 之后的一个版本中移除。
image_id 字符串	在计算环境中启动实例时使用的 Amazon 机器镜像 (AMI) ID。
instance_role 字符串 / 必填	应用于计算环境中 Amazon EC2 实例的 Amazon ECS 实例角色。
instance_types 列表 / 元素=字符串 / 必填	可以启动的实例类型。
maxv_cpus 整数 / 必填	环境可以达到的最大 EC2 vCPU 数量。
minv_cpus 整数 / 必填	环境应保持的最小 EC2 vCPU 数量。
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 之后的一个版本中移除。
security_group_ids 列表 / 元素=字符串 / 必填	与在计算环境中启动的实例关联的 EC2 安全组。
service_role 字符串 / 必填	允许 AWS Batch 代表您调用其他 AWS 服务的 IAM 角色的完整 Amazon 资源名称 (ARN)。
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 选项互斥。 在 3.2.0 版本中添加了 aws_session_token 和 session_token 别名，在 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 之后的一个版本中移除。
spot_iam_fleet_role 字符串	应用于现货计算环境的 Amazon EC2 现货请求 IAM 角色的 Amazon 资源名称 (ARN)。
state 字符串	描述所需状态。 选项 "present" ← (默认) "absent"
subnets 列表 / 元素=字符串 / 必填	启动计算资源的 VPC 子网。
tags 字典	要应用于在计算环境中启动的资源的键值对标签。
type 字符串 / 必填	计算环境的类型。 选项 "MANAGED" "UNMANAGED"
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。

示例

- name: My Batch Compute Environment
  community.aws.batch_compute_environment:
    compute_environment_name: computeEnvironmentName
    state: present
    region: us-east-1
    compute_environment_state: ENABLED
    type: MANAGED
    compute_resource_type: EC2
    minv_cpus: 0
    maxv_cpus: 2
    desiredv_cpus: 1
    instance_types:
      - optimal
    subnets:
      - my-subnet1
      - my-subnet2
    security_group_ids:
      - my-sg1
      - my-sg2
    instance_role: arn:aws:iam::<account>:instance-profile/<role>
    tags:
      tag1: value1
      tag2: value2
    service_role: arn:aws:iam::<account>:role/service-role/<role>
  register: aws_batch_compute_environment_action

- name: show results
  ansible.builtin.debug:
    var: aws_batch_compute_environment_action

返回值

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

键

描述

output 字典

返回执行的操作、是否进行了更改、调用和响应 返回：始终 示例： {"batch_compute_environment_action": "none", "changed": false, "invocation": {"module_args": {"access_key": null, "bid_percentage": null, "compute_environment_name": "<name>", "compute_environment_state": "ENABLED", "compute_resource_type": "EC2", "desiredv_cpus": 0, "ec2_key_pair": null, "endpoint_url": null, "image_id": null, "instance_role": "arn:aws:iam::...", "instance_types": ["optimal"], "maxv_cpus": 8, "minv_cpus": 0, "profile": null, "region": "us-east-1", "secret_key": null, "security_group_ids": ["*******"], "security_token": null, "service_role": "arn:aws:iam::....", "spot_iam_fleet_role": null, "state": "present", "subnets": ["******"], "tags": {"Environment": "<name>", "Name": "<name>"}, "type": "MANAGED", "validate_certs": true}}, "response": {"computeEnvironmentArn": "arn:aws:batch:....", "computeEnvironmentName": "<name>", "computeResources": {"desiredvCpus": 0, "instanceRole": "arn:aws:iam::...", "instanceTypes": ["optimal"], "maxvCpus": 8, "minvCpus": 0, "securityGroupIds": ["******"], "subnets": ["*******"], "tags": {"Environment": "<name>", "Name": "<name>"}, "type": "EC2"}, "ecsClusterArn": "arn:aws:ecs:.....", "serviceRole": "arn:aws:iam::...", "state": "ENABLED", "status": "VALID", "statusReason": "ComputeEnvironment Healthy", "type": "MANAGED"}}

作者

• Jon Meran (@jonmer85)

集合链接

• 问题跟踪器
• 代码仓库 (源代码)
• 沟通