amazon.aws.iam_user 模块 – 管理 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。

amazon.aws 5.0.0 中的新增功能

概要

• 一个用于管理 AWS IAM 用户的模块。

• 此模块不管理用户所属的组，可以使用 amazon.aws.iam_group 管理组成员身份。

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

要求

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

• 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。
boundary 别名：boundary_policy_arn、permissions_boundary 字符串 amazon.aws 7.2.0 中新增	要应用于此用户的 IAM 托管策略的 ARN。 边界策略可用于限制用户可以执行的权限，但本身并不授予任何策略。 有关边界的更多信息，请参见 https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html。 设置为空字符串 "" 以删除边界策略。
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 字符串	连接到的 URL，而不是默认的 AWS 端点。虽然这可用于连接到其他与 AWS 兼容的服务，但 amazon.aws 和 community.aws 集合仅针对 AWS 进行测试。 也可以使用 AWS_URL 或 EC2_URL 环境变量，优先级依次递减。 ec2_url 和 s3_url 别名已弃用，将在 2024-12-01 之后的一个版本中移除。 EC2_URL 环境变量的支持已弃用，将在 2024-12-01 之后的一个版本中移除。
managed_policies 别名：managed_policy 列表 / 元素=字符串	要附加到用户的托管策略 ARN 或友好名称列表。 要嵌入内联策略，请使用 community.aws.iam_policy。 默认值： []
name 别名：user_name 字符串 / 必需	用户的名称。 注意：用户名在帐户内是唯一的。路径（path）不会影响 name 的唯一性要求。例如，不允许在同一个帐户中同时拥有 /Path1/MyUser 和 /Path2/MyUser。 在 7.2.0 版本中添加了 user_name 作为别名。
password 字符串 community.aws 2.2.0 中新增	要应用于用户的密码。
password_reset_required 布尔值 新增于 community.aws 3.1.0	定义用户登录时是否需要设置新密码。 除非设置新密码，否则会被忽略。 选项 false ← (默认) true
path 别名：prefix, path_prefix 字符串 amazon.aws 7.2.0 中新增	用户的路径。 有关 IAM 路径的更多信息，请参阅 AWS IAM 标识符文档 https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html。
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 选项互斥。
purge_policies 别名：purge_policy, purge_managed_policies 布尔值	当 purge_policies=true 时，managed_policies 中未列出的任何托管策略都将被分离。 选项 false ← (默认) true
purge_tags 布尔值	如果 purge_tags=true 且设置了 tags，则将从资源中清除现有标签，以完全匹配 tags 参数定义的内容。 如果没有设置 tags 参数，即使 purge_tags=True，标签也不会被修改。 以 aws: 开头的标签键由 Amazon 保留，无法修改。因此，在 purge_tags 参数中将忽略它们。有关更多信息，请参阅 Amazon 文档 https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html#tag-conventions。 选项 false true ← (默认)
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 之后的一个版本中移除。
remove_password 布尔值 community.aws 2.2.0 中新增	删除用户登录密码的选项。 此字段与 password 互斥。 选项 false true
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 之后的一个版本中移除。
state 字符串 / 必需	创建或删除 IAM 用户。 选项 "present" "absent"
tags 别名：resource_tags 字典	表示要应用于资源的标签的字典。 如果没有设置 tags 参数，则不会修改标签。
update_password 字符串 community.aws 2.2.0 中新增	何时更新用户密码。 update_password=always 将确保密码设置为 password。 update_password=on_create 仅为新创建的用户设置密码。 选项 "always" ← (默认) "on_create"
validate_certs 布尔值	设置为 false 时，将不会验证与 AWS API 通信的 SSL 证书。 强烈建议不要设置 validate_certs=false，作为替代方案，请考虑设置 aws_ca_bundle。 选项 false true ← (默认)
wait 布尔值 community.aws 2.2.0 中新增	当 wait=True 时，模块最多将等待 wait_timeout 秒来创建 IAM 用户，然后再返回。 选项 false true ← (默认)
wait_timeout 整数 community.aws 2.2.0 中新增	等待创建/更新完成的时间（以秒为单位）。 默认： 120

注释

注意

• 对 tags 和 purge_tags 的支持在 2.1.0 版本中添加。

• 警告：对于模块，环境变量和配置文件是从 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.
# Note: This module does not allow management of groups that users belong to.
#       Groups should manage their membership directly using amazon.aws.iam_group,
#       as users belong to them.

- name: Create a user
  amazon.aws.iam_user:
    name: testuser1
    state: present

- name: Create a user with a password
  amazon.aws.iam_user:
    name: testuser1
    password: SomeSecurePassword
    state: present

- name: Create a user and attach a managed policy using its ARN
  amazon.aws.iam_user:
    name: testuser1
    managed_policies:
      - arn:aws:iam::aws:policy/AmazonSNSFullAccess
    state: present

- name: Remove all managed policies from an existing user with an empty list
  amazon.aws.iam_user:
    name: testuser1
    state: present
    purge_policies: true

- name: Create user with tags
  amazon.aws.iam_user:
    name: testuser1
    state: present
    tags:
      Env: Prod

- name: Delete the user
  amazon.aws.iam_user:
    name: testuser1
    state: absent

返回值

常用返回值已在 此处 记录，以下是此模块特有的字段

键	描述
user 复杂	包含所有用户信息的字典。 返回：成功
arn 字符串	指定用户的 Amazon 资源名称 (ARN)。 返回：始终 示例： "arn:aws:iam::123456789012:user/testuser1"
attached_policies 列表 / 元素=字典 amazon.aws 7.2.0 中新增	包含附加到组的托管策略的基本信息的列表。 返回：始终 示例： [{"policy_arn": "arn:aws:iam::123456789012:policy/test_policy", "policy_name": "test_policy"}]
policy_arn 字符串	指定托管策略的 Amazon 资源名称 (ARN)。 返回：成功 示例： "arn:aws:iam::123456789012:policy/test_policy"
policy_name 字符串	标识策略的友好名称。 返回：成功 示例： "test_policy"
create_date 字符串	用户创建的日期和时间，采用 ISO 8601 日期时间格式。 返回：始终 示例： "2017-02-08T04:36:28+00:00"
路径 字符串	用户路径。 返回：始终 示例： "/"
tags 字典	用户标签。 返回：始终 示例： {"Env": "Prod"}
user_id 字符串	用于稳定唯一标识用户的字符串。 返回：始终 示例： "AGPA12345EXAMPLE54321"
user_name 字符串	用于标识用户的友好名称。 返回：始终 示例： "testuser1"

作者

• Josh Souza (@joshsouza)

资源链接

• 问题追踪器
• 代码库 (源代码)
• 通信