community.aws.ecs_taskdefinition_info 模块 – 描述 ECS 中的任务定义

注意

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

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

要安装它，请使用： ansible-galaxy collection install community.aws。您需要其他要求才能使用此模块，请参阅要求了解详情。

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

community.aws 1.0.0 中的新增功能

概要 

描述 ECS 中的任务定义。

要求 

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

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`
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 之后的一个版本中删除。
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 之后的一个版本中移除。
task_definition 字符串 / 必填	要获取详细信息的任务定义的名称。
validate_certs 布尔值	设置为 `false` 时，将不会验证与 AWS API 通信的 SSL 证书。强烈建议不要设置 validate_certs=false，作为替代方案，请考虑设置 aws_ca_bundle。选项 `false` `true` ← (默认)

备注 

注意

有关参数和返回值的详细信息，请参见 http://boto3.readthedocs.io/en/latest/reference/services/ecs.html#ECS.Client.describe_task_definition
警告：对于模块，环境变量和配置文件是从 Ansible 的“主机”上下文而不是“控制器”上下文读取的。因此，可能需要显式地将文件复制到“主机”。对于查找和连接插件，环境变量和配置文件是从 Ansible 的“控制器”上下文而不是“主机”上下文读取的。
Ansible 使用的 AWS SDK (boto3) 也可能从 Ansible “主机”上下文中的配置文件（通常为 ~/.aws/credentials）读取凭据和其他设置的默认值，例如区域。更多信息，请参见 https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html。

示例 

# Note: These examples do not set authentication details, see the AWS Guide for details.

- community.aws.ecs_taskdefinition_info:
    task_definition: test-td

返回值 

公共返回值已在此处记录，以下是此模块独有的字段。

键	描述
container_definitions 复杂类型	返回表示容器的复杂对象的列表。返回值：成功
command 字符串	传递给容器的命令。返回值：存在时
cpu 整数	为容器保留的 CPU 单位数。返回值：始终
disableNetworking 布尔值	如果此参数为 true，则在容器内禁用网络。返回值：存在时
dnsSearchDomains 字符串	提供给容器的 DNS 搜索域列表。返回值：存在时
dnsServers 字符串	提供给容器的 DNS 服务器列表。返回值：存在时
dockerLabels 字符串	要添加到容器的标签的键/值映射。返回值：存在时
dockerSecurityOptions 字符串	用于为 SELinux 和 AppArmor 多级安全系统提供自定义标签的字符串列表。返回值：存在时
entryPoint 字符串	传递给容器的入口点。返回值：存在时
environment 复杂类型	要传递给容器的环境变量。返回值：始终
name 字符串	环境变量的名称。返回值：存在时
value 字符串	环境变量的值。返回值：存在时
essential 布尔值	这是否是一个必要的容器。返回值：始终
extraHosts 复杂类型	要追加到容器上 /etc/hosts 文件的主机名和 IP 地址映射列表。返回值：存在时
hostname 字符串	在 /etc/hosts 条目中使用的主机名。返回值：存在时
ipAddress 字符串	在 /etc/hosts 条目中使用的 IP 地址。返回值：存在时
firelensConfiguration 字典	容器的 FireLens 配置。返回值：存在时
options 字典	配置日志路由器时使用的选项。返回值：成功
type 字符串	日志路由器。返回值：成功
healthCheck 字典	容器的容器健康检查命令和相关的配置参数。返回值：存在时
command 列表 / 元素=字符串	表示容器运行以确定其是否健康的命令的字符串数组。返回值：成功
interval 整数	每次健康检查执行之间的时间段（以秒为单位）。返回值：成功
retries 整数	在容器被认为不健康之前，重试失败健康检查的次数。返回值：成功
startPeriod 整数	用于为容器提供在失败之前引导的时间的可选宽限期。返回值：成功
timeout 整数	在将其视为失败之前等待健康检查成功的时间段（以秒为单位）。返回值：成功
hostname 字符串	要用于容器的主机名。返回值：存在时
image 字符串	用于启动容器的镜像。返回值：始终
links 字符串	到其他容器的链接。返回值：存在时
logConfiguration 字符串	容器的日志配置规范。返回值：存在时
memoryReservation 整数	为容器保留的内存的软限制（以 MiB 为单位）。返回值：存在时
mountPoints 复杂类型	容器中数据卷的挂载点。返回值：始终
containerPath 字符串	在容器上挂载主机卷的路径。返回值：存在时
readOnly 布尔值	如果此值为 true，则容器对卷具有只读访问权限。如果此值为 false，则容器可以写入卷。返回值：存在时
sourceVolume 字符串	要挂载的卷的名称。返回值：存在时
name 字符串	容器的名称。返回值：始终
options 字符串	要发送到日志驱动程序的配置选项。返回值：存在时
portMappings 复杂类型	容器的端口映射列表。返回值：始终
containerPort 整数	容器上的端口号。返回值：存在时
hostPort 整数	要在容器实例上为容器保留的端口号。返回值：存在时
protocol 字符串	用于端口映射的协议。返回值：存在时
privileged 布尔值	如果此参数为 true，则容器将在主机容器实例上获得提升的权限（类似于 root 用户）。返回值：存在时
readonlyRootFilesystem 布尔值	如果此参数为 true，则容器将获得对其根文件系统的只读访问权限。返回值：存在时
resourceRequirements 字典	要分配给容器的资源的类型和数量。返回值：存在时
type 字符串	要分配给容器的资源类型。返回值：成功
value 字符串	指定资源类型的值。返回值：成功
systemControls 字典	要在容器中设置的命名空间内核参数列表。返回值：存在时
namespace 字符串	命名空间内核。返回值：成功
value 字符串	命名空间内核的值。返回值：成功
ulimits 复杂类型	要在容器中设置的 ulimits 列表。返回值：存在时
hardLimit 整数	ulimit 类型的硬限制。返回值：存在时
name 字符串	ulimit 的类型。返回值：存在时
softLimit 整数	ulimit 类型的软限制。返回值：存在时
user 字符串	要在容器内使用的用户名。返回值：存在时
volumesFrom 复杂类型	要从另一个容器挂载的数据卷。返回值：始终
readOnly 布尔值	如果此值为 true，则容器对卷具有只读访问权限。如果此值为 false，则容器可以写入卷。返回值：存在时
sourceContainer 字符串	在同一任务定义中要从中挂载卷的另一个容器的名称。返回值：存在时
workingDirectory 字符串	在容器内运行命令的工作目录。返回值：存在时
family 字符串	任务定义的家族名，用作定义名称返回值：始终
network_mode 字符串	容器的网络模式返回值：始终
placement_constraints 复杂类型	用于任务的一组放置约束对象返回值：始终
expression 字符串	应用于约束的集群查询语言表达式。返回值：存在时
type 字符串	约束的类型。返回值：存在时
requires_attributes 复杂类型	任务所需的容器实例属性返回值：存在时
name 字符串	属性的名称。返回值：存在时
targetId 字符串	目标的ID。返回值：存在时
targetType 字符串	要附加属性的目标类型。返回值：存在时
value 字符串	属性的值。返回值：存在时
revision 整数	查询到的修订号返回值：始终
status 字符串	任务定义的状态返回值：始终
task_definition_arn 字符串	任务定义的ARN 返回值：始终
task_role_arn 字符串	此任务中容器可以假定的 IAM 角色的 ARN 返回：当设置角色时
volumes 复杂类型	任务中的卷列表返回值：始终
host 布尔值	host 参数的内容决定你的数据卷是否在主机容器实例上持久化以及存储位置。返回值：存在时
name 字符串	卷的名称。返回值：存在时
source_path 字符串	提供给容器的主机容器实例上的路径。返回值：存在时

作者

Gustavo Maia (@gurumaia)
Mark Chance (@Java1Guy)
Darek Kaczynski (@kaczynskid)