amazon.aws.iam_user_info 模块 – 在 AWS 中收集 IAM 用户信息

注意

此模块是 amazon.aws 集合（版本 9.0.0）的一部分。

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

要安装它，请使用：ansible-galaxy collection install amazon.aws。您需要进一步的要求才能使用此模块，请参阅 要求 以了解详细信息。

要在 playbook 中使用它，请指定：amazon.aws.iam_user_info。

amazon.aws 5.0.0 中的新功能

概要

  • 此模块可用于在 AWS 中收集 IAM 用户的信息。

  • 此模块最初在 1.0.0 版本中添加到 community.aws。

要求

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

  • 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 之后的版本中删除。

group

别名：group_name

字符串

要查找的 IAM 用户的组名称。与 path 互斥。

group_name 在 7.2.0 版本中添加为别名。

name

别名：user_name

字符串

要查找的 IAM 用户的名称。

user_name 在 7.2.0 版本中添加为别名。

path_prefix

别名：path, prefix

字符串

IAM 用户的路径。与 group 互斥。

如果指定，则会获取路径以用户提供的值开头的所有用户名。

默认值： "/"

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 保持一致，aws_secret_access_key 别名已在 5.1.0 版本中添加。

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 选项互斥。

别名 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 ← (默认)

注释

注意

  • 注意： 对于模块，环境变量和配置文件是从 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.
# Gather facts about "test" user.
- name: Get IAM user info
  amazon.aws.iam_user_info:
    name: "test"

# Gather facts about all users in the "dev" group.
- name: Get IAM user info
  amazon.aws.iam_user_info:
    group: "dev"

# Gather facts about all users with "/division_abc/subdivision_xyz/" path.
- name: Get IAM user info
  amazon.aws.iam_user_info:
    path: "/division_abc/subdivision_xyz/"

返回值

常见的返回值在此处记录 这里，以下是此模块独有的字段

键

描述

iam_users

复杂

匹配的 iam 用户列表。

返回: 始终

arn

字符串

用户的 ARN。

返回: 当用户存在时。

示例: "arn:aws:iam::123456789012:user/dev/test_user"

create_date

字符串

用户创建的日期时间。

返回: 当用户存在时。

示例: "2016-05-24T12:24:59+00:00"

login_profile

字典

如果用户有权从 AWS 默认控制台登录，则显示详细的登录配置文件信息。

如果无权访问，则返回一个空对象 {}。

返回: 当用户存在时。

示例: {"create_date": "2024-03-20T12:50:56+00:00", "password_reset_required": false, "user_name": "i_am_a_user"}

create_date

字符串

用户创建的日期和时间，采用 ISO 8601 日期时间格式。

返回: 始终

password_reset_required

布尔值

指定是否要求用户在下次登录时设置新密码。

返回: 始终

user_name

字符串

IAM 用户名

返回: 始终

password_last_used

字符串

用户上次使用密码的日期时间。

返回: 如果密码至少使用过一次

示例: "2016-05-25T13:39:11+00:00"

路径

字符串

用户的路径。

返回: 当用户存在时。

示例: "/dev/"

tags

字典

用户标签。

返回: 当用户存在时。

示例: {"Env": "Prod"}

user_id

字符串

唯一用户 ID。

返回: 当用户存在时。

示例: "AIDUIOOCQKTUGI6QJLGH2"

user_name

字符串

用户名。

返回: 当用户存在时。

示例: "test_user"

作者

  • Constantin Bugneac (@Constantin07)

  • Abhijeet Kasurde (@Akasurde)