community.aws.ecs_task 模块 – 在 ECS 中运行、启动或停止任务
注意
此模块是 community.aws 集合 (版本 9.0.0) 的一部分。
如果您正在使用 ansible 包，则可能已安装此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用：ansible-galaxy collection install community.aws。您需要其他要求才能使用此模块，有关详细信息，请参阅 需求。
要在剧本中使用它，请指定：community.aws.ecs_task。
community.aws 1.0.0 中的新增功能
概要
创建或删除任务定义的实例。
需求
执行此模块的主机需要以下需求。
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。 |
|
要在其上运行任务的集群的名称。 如果未指定，集群名称将为 默认值： |
|
要在其上部署任务的容器实例列表。 |
|
要启动的新实例数量。 |
|
使用 还可以使用 选项
|
|
连接到默认 AWS 端点以外的端点的 URL。虽然这可以用于连接到其他与 AWS 兼容的服务，但 amazon.aws 和 community.aws 集合仅针对 AWS 进行了测试。 还可以按优先级递减的顺序使用 ec2_url 和 s3_url 别名已弃用，将在 2024-12-01 后的某个版本中删除。
|
|
运行服务的启动类型。 选项
|
|
服务的网络配置。仅适用于使用network_mode=awsvpc创建的任务定义。 |
|
任务的弹性网络接口是否接收公共 IP 地址。 选项
|
|
任务的组名称或组 ID 列表。 |
|
任务连接到的子网 ID 列表。 |
|
要执行的任务操作。 当operation=run时，必须设置task_definition。 当operation=start时，必须同时设置task_definition和container_instances。 当operation=stop时，必须同时设置task_definition和task。 选项
|
|
传递给新实例的值的字典。 |
|
用于身份验证的命名 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 密钥。 有关访问令牌的更多信息，请参阅 AWS 文档 https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys。 也可以按优先级递减顺序使用 secret_key和profile选项互斥。 为与 AWS botocore SDK 保持一致，在 5.1.0 版本中添加了aws_secret_access_key别名。 已弃用ec2_secret_key别名，将在 2024-12-01 之后的一个版本中移除。 已弃用对 |
|
与临时凭据一起使用的 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选项互斥。 在 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 之后的一个版本中移除。 已弃用对 |
|
显示谁或什么启动了任务的值（用于信息目的）。 |
|
将在启动和运行时添加到 ecs 任务的标签 |
|
要停止的任务的 ARN。 |
|
要启动、运行或停止的任务定义。 |
|
设置为 强烈建议不要设置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。
示例
# Simple example of run task
- name: Run task
community.aws.ecs_task:
operation: run
cluster: console-sample-app-static-cluster
task_definition: console-sample-app-static-taskdef
count: 1
started_by: ansible_user
register: task_output
# Simple example of start task
- name: Start a task
community.aws.ecs_task:
operation: start
cluster: console-sample-app-static-cluster
task_definition: console-sample-app-static-taskdef
task: "arn:aws:ecs:us-west-2:123456789012:task/3f8353d1-29a8-4689-bbf6-ad79937ffe8a"
tags:
resourceName: a_task_for_ansible_to_run
type: long_running_task
network: internal
version: 1.4
container_instances:
- arn:aws:ecs:us-west-2:123456789012:container-instance/79c23f22-876c-438a-bddf-55c98a3538a8
started_by: ansible_user
network_configuration:
subnets:
- subnet-abcd1234
security_groups:
- sg-aaaa1111
- my_security_group
register: task_output
- name: RUN a task on Fargate
community.aws.ecs_task:
operation: run
cluster: console-sample-app-static-cluster
task_definition: console-sample-app-static-taskdef
task: "arn:aws:ecs:us-west-2:123456789012:task/3f8353d1-29a8-4689-bbf6-ad79937ffe8a"
started_by: ansible_user
launch_type: FARGATE
network_configuration:
subnets:
- subnet-abcd1234
security_groups:
- sg-aaaa1111
- my_security_group
register: task_output
- name: RUN a task on Fargate with public ip assigned
community.aws.ecs_task:
operation: run
count: 2
cluster: console-sample-app-static-cluster
task_definition: console-sample-app-static-taskdef
task: "arn:aws:ecs:us-west-2:123456789012:task/3f8353d1-29a8-4689-bbf6-ad79937ffe8a"
started_by: ansible_user
launch_type: FARGATE
network_configuration:
assign_public_ip: true
subnets:
- subnet-abcd1234
register: task_output
- name: Stop a task
community.aws.ecs_task:
operation: stop
cluster: console-sample-app-static-cluster
task_definition: console-sample-app-static-taskdef
task: "arn:aws:ecs:us-west-2:123456789012:task/3f8353d1-29a8-4689-bbf6-ad79937ffe8a"
返回值
常用的返回值已在 此处 记录，以下是此模块特有的字段
键 |
描述 |
|---|---|
有关已启动任务的详细信息 返回：成功 |
|
托管任务的集群的 Amazon 资源名称 (ARN)。 返回：仅当 details 为 true 时 |
|
运行任务的容器的 Amazon 资源名称 (ARN)。 返回：仅当 details 为 true 时 |
|
容器详细信息。 返回：仅当 details 为 true 时 |
|
创建任务的时间戳。 返回：仅当 details 为 true 时 |
|
任务的所需状态。 返回：仅当 details 为 true 时 |
|
任务的最后记录状态。 返回：仅当 details 为 true 时 |
|
运行任务的启动类型。 返回：始终 |
|
为此任务设置的容器覆盖。 返回：仅当 details 为 true 时 |
|
启动任务的时间戳。 返回：仅当 details 为 true 时 |
|
启动任务的用户。 返回：仅当 details 为 true 时 |
|
停止任务的时间戳。 返回：仅当 details 为 true 时 |
|
停止任务的原因。 返回：仅当 details 为 true 时 |
|
标识任务的 Amazon 资源名称 (ARN)。 返回：始终 |
|
任务定义的 Amazon 资源名称 (ARN)。 返回：仅当 details 为 true 时 |