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
参数
参数 |
注释 |
---|---|
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 和 profile 选项是互斥的。 为了与 AWS botocore SDK 保持一致,在 5.1.0 版本中添加了 aws_access_key_id 别名。 ec2_access_key 别名已被弃用,将在 2024-12-01 之后的版本中删除。 对 |
|
验证 SSL 证书时使用的 CA 捆绑包的位置。 也可以使用 |
|
用于修改 botocore 配置的字典。 参数可以在 AWS 文档中找到 https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config。 |
|
在启动实例之前,Spot 实例价格与该实例类型的按需价格相比必须达到的最低百分比。 例如,如果您的竞价百分比为 20%,则 Spot 价格必须低于当前 EC2 实例按需价格的 20%。 |
|
您的计算环境的名称。 允许最多 128 个字母(大写和小写)、数字和下划线。 |
|
计算环境的状态。 如果状态为 选择
|
|
计算资源的类型。 选择
|
|
使用 也可以使用 选择
|
|
计算环境中所需的 EC2 vCPU 数量。 |
|
用于在计算环境中启动实例的 EC2 密钥对。 |
|
连接时使用的 URL,而不是默认的 AWS 终端节点。虽然这可以用于连接到其他 AWS 兼容服务,但 amazon.aws 和 community.aws 集合仅针对 AWS 进行测试。 也可以使用 ec2_url 和 s3_url 别名已被弃用,将在 2024-12-01 之后的版本中删除。 对 |
|
用于在计算环境中启动实例的 Amazon Machine Image (AMI) ID。 |
|
应用于计算环境中 Amazon EC2 实例的 Amazon ECS 实例角色。 |
|
可以启动的实例类型。 |
|
环境可以达到的 EC2 vCPU 最大数量。 |
|
环境应维护的 EC2 vCPU 最小数量。 |
|
用于身份验证的已命名 AWS 配置文件。 有关已命名配置文件的更多信息,请参阅 AWS 文档 https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html。 也可以使用 profile 选项与 aws_access_key、aws_secret_key 和 security_token 选项互斥。 |
|
要使用的 AWS 区域。 对于诸如 IAM、Route53 和 CloudFront 之类的全局服务,将忽略 region。 也可以使用 有关更多信息,请参阅 Amazon AWS 文档 http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region。
对 |
|
AWS secret access key。 有关访问令牌的更多信息,请参阅 AWS 文档 https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys。 也可以按优先级递减的顺序使用 secret_key 和 profile 选项互斥。 aws_secret_access_key 别名在 5.1.0 版本中添加,以与 AWS botocore SDK 保持一致。 ec2_secret_key 别名已被弃用,将在 2024-12-01 之后的版本中删除。 对 |
|
与计算环境中启动的实例关联的 EC2 安全组。 |
|
允许 AWS Batch 代表您调用其他 AWS 服务的 IAM 角色的完整 Amazon 资源名称 (ARN)。 |
|
用于临时凭证的 AWS STS 会话令牌。 有关访问令牌的更多信息,请参阅 AWS 文档 https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys。 也可以按优先级递减的顺序使用 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 之后的版本中删除。 对 |
|
应用于 SPOT 计算环境的 Amazon EC2 Spot Fleet IAM 角色的 Amazon 资源名称 (ARN)。 |
|
描述所需的状态。 选择
|
|
计算资源启动到的 VPC 子网。 |
|
要应用于计算环境中启动的资源的键值对标签。 |
|
计算环境的类型。 选择
|
|
设置为 强烈建议不要设置 validate_certs=false,作为替代方案,请考虑设置 aws_ca_bundle。 选择
|
注释
注意
注意: 对于模块,环境变量和配置文件是从 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
返回值
通用返回值记录在这里,以下是此模块独有的字段
键 |
描述 |
---|---|
返回采取的操作、是否发生更改、调用和响应 返回值: 总是 示例: |