community.aws.ecs_service_info 模块 – 列出或描述 ECS 中的服务

注意

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

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

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

要在 playbook 中使用它，请指定：community.aws.ecs_service_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。
cluster 字符串	要在其中列出服务的集群 ARN。
debug_botocore_endpoint_logs 布尔值	使用 botocore.endpoint 记录器来解析任务期间进行的唯一（而不是总的）"resource:action" API 调用，并将该集合输出到任务结果中的 resource_actions 键。使用 aws_resource_action 回调来输出 playbook 期间生成的总列表。 也可以使用环境变量 ANSIBLE_DEBUG_BOTOCORE_LOGS。 选择 false ←（默认） true
details 布尔值	如果要获取有关服务的详细信息，请将其设置为 true。 选择 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 之后的版本中删除。
events 布尔值	是否返回 ECS 服务事件。仅当 details=true 时才有效。 选择 false true ←（默认）
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 secret access 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 之后的版本中删除。
service 别名：name list / elements=string	要获取详细信息的一个或多个服务
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 选项是互斥的。 别名 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 之后的版本中删除。 对 EC2_SECRET_KEY 和 AWS_SECURITY_TOKEN 环境变量的支持已被弃用，将在 2024-12-01 之后的版本中删除。
validate_certs 布尔值	当设置为 false 时，与 AWS API 通信时将不验证 SSL 证书。 强烈建议不要设置 validate_certs=false，作为替代方案，请考虑设置 aws_ca_bundle。 选择 false true ←（默认）

Notes

注意

• 注意： 对于模块，环境变量和配置文件是从 Ansible “主机” 上下文而不是 “控制器” 上下文读取的。因此，可能需要将文件显式复制到 “主机”。 对于查找和连接插件，环境变量和配置文件是从 Ansible “控制器” 上下文而不是 “主机” 上下文读取的。

• Ansible 使用的 AWS SDK (boto3) 也可能从 Ansible “主机” 上下文中的配置文件（通常为 ~/.aws/credentials）读取凭证和其他设置（例如区域）的默认值。 有关更多信息，请参见 https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html。

Examples

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

# Basic listing example
- community.aws.ecs_service_info:
    cluster: test-cluster
    service: console-test-service
    details: true
  register: output

# Basic listing example
- community.aws.ecs_service_info:
    cluster: test-cluster
  register: output

Return Values

常见的返回值在 这里 进行了文档说明，以下是此模块独有的字段

键	描述
services complex	当 details 为 false 时，返回服务 ARN 的数组，否则返回如下所述的复杂对象数组。 返回： 成功
clusterArn 字符串	托管该服务的集群的 Amazon 资源名称 (ARN)。 返回： 始终
deployments list / elements=dictionary	服务部署列表 返回： 始终
desiredCount integer	要在服务上保持运行的任务定义的所需实例数。 返回： 始终
events list / elements=dictionary	服务事件列表 返回： 当 events 为 true 时
loadBalancers complex	负载均衡器对象列表 返回： 始终
containerName 字符串	要与负载均衡器关联的容器的名称。 返回： 始终
containerPort integer	要与负载均衡器关联的容器上的端口。 返回： 始终
loadBalancerName 字符串	名称 返回： 始终
pendingCount integer	集群中处于 PENDING 状态的任务数。 返回： 始终
runningCount integer	集群中处于 RUNNING 状态的任务数。 返回： 始终
serviceArn 字符串	标识该服务的 Amazon 资源名称 (ARN)。 该 ARN 包含 arn:aws:ecs 命名空间，后跟服务的区域、服务所有者的 AWS 账户 ID、服务命名空间，然后是服务名称。 返回： 始终 示例： "arn:aws:ecs:us-east-1:123456789012:service/my-service"
serviceName 字符串	用于标识服务的用户生成的字符串 返回： 始终
status 字符串	有效值为 ACTIVE、DRAINING 或 INACTIVE。 返回： 始终
taskDefinition 字符串	用于服务中任务的任务定义的 ARN。 返回： 始终

作者

• Mark Chance (@Java1Guy)

• Darek Kaczynski (@kaczynskid)

集合链接

• 问题跟踪器
• 存储库（源代码）
• 沟通