community.aws.batch_job_queue 模块 – 管理 AWS Batch 作业队列

注意

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

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

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

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

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_job_queue。用法没有改变。

别名：aws_batch_job_queue

要求

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

• 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。
compute_environment_order 列表 / 元素=字典 / 必需	映射到作业队列的计算环境集及其相互之间的顺序。作业调度程序使用此参数来确定哪个计算环境应执行给定作业。在将计算环境与作业队列关联之前，计算环境必须处于 VALID 状态。您可以将最多 3 个计算环境与作业队列关联。
compute_environment 字符串	计算环境的名称。
order 整数	环境的相对优先级。
debug_botocore_endpoint_logs 布尔值	使用 botocore.endpoint 日志记录器来解析在任务期间进行的唯一（而不是总计）"resource:action" API 调用，将集合输出到任务结果中的 resource_actions 密钥。使用 aws_resource_action 回调将输出到 playbook 期间进行的总列表。 也可以使用 ANSIBLE_DEBUG_BOTOCORE_LOGS 环境变量。 选项 false ← (默认) true
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 之后的一个版本中移除。
job_queue_name 字符串 / 必需	作业队列的名称。
job_queue_state 字符串	作业队列的状态。如果作业队列状态为 ENABLED，则它能够接受作业。 选项 "ENABLED" ← (默认) "DISABLED"
优先级 整数 / 必需	作业队列的优先级。与相同计算环境关联时，优先级较高的作业队列（或优先级参数的整数值较低）会优先评估。优先级按升序确定，例如，优先级值为 1 的作业队列比优先级值为 10 的作业队列具有更高的调度优先级。
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 选项互斥。 在 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 之后的发行版中删除。
状态 字符串	描述所需状态。 选项 "present" ← (默认) "absent"
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 Job Queue
  community.aws.batch_job_queue:
    job_queue_name: jobQueueName
    state: present
    region: us-east-1
    job_queue_state: ENABLED
    priority: 1
    compute_environment_order:
      - order: 1
        compute_environment: my_compute_env1
      - order: 2
        compute_environment: my_compute_env2
  register: batch_job_queue_action

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

返回值

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

键	描述
输出 字典	返回执行的操作、是否进行了更改、调用和响应 返回：始终 示例： {"batch_job_queue_action": "updated", "changed": false, "response": {"job_queue_arn": "arn:aws:batch:....", "job_queue_name": "<name>", "priority": 1, "state": "DISABLED", "status": "UPDATING", "status_reason": "JobQueue Healthy"}}

作者

• Jon Meran (@jonmer85)

集合链接

• 问题追踪器
• 代码库（源代码）
• 沟通