amazon.aws.iam_role 模块 – 管理 AWS IAM 角色

注意

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

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

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

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

community.aws 1.0.0 中的新增功能

概要

• 管理 AWS IAM 角色。

要求

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

• 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 之后的版本中删除。
assume_role_policy_document json	允许实体承担角色的信任关系策略文档。 当 state=present 时，此参数是必需的。
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 字符串	用于限制此角色可以传递给它创建的 IAM 角色/用户的权限的 IAM 管理策略的 ARN。 边界不能在实例配置文件上设置，因此如果指定此选项，则 create_instance_profile 必须为 false。 这是为具有创建新 IAM 对象权限的角色/用户准备的。 有关边界的更多信息，请参阅 https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html。
create_instance_profile 布尔值	如果不存在具有相同 name 的 IAM 实例配置文件，则设置 create_instance_profile=True 将创建 IAM 实例配置文件以及角色。 此选项已被弃用，将在 2026-05-01 之后的版本中删除。可以使用 amazon.aws.iam_instance_profile 模块来管理实例配置文件。 默认为 True 选项 false true
debug_botocore_endpoint_logs 布尔值	使用 botocore.endpoint 记录器来解析任务期间执行的唯一（而非总计）"resource:action" API 调用，并将该集合输出到任务结果中的 resource_actions 键中。使用 aws_resource_action 回调来输出 playbook 期间执行的总列表。 也可以使用 ANSIBLE_DEBUG_BOTOCORE_LOGS 环境变量。 选项 false ←（默认） true
delete_instance_profile 布尔值	当 delete_instance_profile=true 并且 state=absent 时，删除角色也会删除与该角色具有相同 name 的实例配置文件，但前提是该实例配置文件与该角色关联。 仅当 state=absent 时适用。 此选项已被弃用，将在 2026-05-01 之后的版本中删除。可以使用 amazon.aws.iam_instance_profile 模块来管理实例配置文件。 默认为 False 选项 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 或友好名称的列表。 要删除所有策略，请设置 purge_policies=true 和 managed_policies=[]。 要嵌入内联策略，请使用 amazon.aws.iam_policy。
max_session_duration 整数	承担角色时会话的最长持续时间（以秒为单位）。 有效值介于 1 到 12 小时之间（3600 到 43200 秒）。
name 别名：role_name 字符串 / 必需	角色的名称。 注意：角色名称在账户内是唯一的。路径（path）不影响 name 的唯一性要求。例如，在同一账户中不允许同时存在 /Path1/MyRole 和 /Path2/MyRole。 role_name 在 7.2.0 版本中添加为别名。
path 别名：prefix, path_prefix 字符串	角色的路径。 有关 IAM 路径的更多信息，请参阅 AWS IAM 标识符文档 https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html。 当前不支持更新现有角色的路径，并且会导致警告。 path_prefix 和 prefix 在 7.2.0 版本中添加为别名。
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 之后的版本中删除。
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_secret_access_key 别名在 5.1.0 版本中添加，以与 AWS botocore SDK 保持一致。 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 之后的版本中删除。
state 字符串	创建或删除 IAM 角色。 选项 "present" ←（默认） "absent"
tags 别名：resource_tags 字典	表示要应用于资源的标签的字典。 如果未设置 tags 参数，则不会修改标签。
validate_certs 布尔值	当设置为 false 时，与 AWS API 通信时将不验证 SSL 证书。 强烈建议不要设置 validate_certs=false，作为替代方案，请考虑设置 aws_ca_bundle。 选项 false true ←（默认）
wait 布尔值	当 wait=True 时，模块将等待 IAM 角色创建完成，最长等待时间为 wait_timeout 秒，然后返回。 选项 false true ←（默认）
wait_timeout 整数	等待创建/更新完成的时间（以秒为单位）。 默认值： 120

注意

注意

• 注意： 对于模块，环境变量和配置文件是从 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.

- name: Create a role with description and tags
  amazon.aws.iam_role:
    name: mynewrole
    assume_role_policy_document: "{{ lookup('file','policy.json') }}"
    description: This is My New Role
    tags:
      env: dev

- name: "Create a role and attach a managed policy called 'PowerUserAccess'"
  amazon.aws.iam_role:
    name: mynewrole
    assume_role_policy_document: "{{ lookup('file','policy.json') }}"
    managed_policies:
      - arn:aws:iam::aws:policy/PowerUserAccess

- name: Keep the role created above but remove all managed policies
  amazon.aws.iam_role:
    name: mynewrole
    assume_role_policy_document: "{{ lookup('file','policy.json') }}"
    managed_policies: []

- name: Delete the role
  amazon.aws.iam_role:
    name: mynewrole
    assume_role_policy_document: "{{ lookup('file', 'policy.json') }}"
    state: absent

返回值

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

键	描述
iam_role 复杂	包含 IAM 角色数据的字典。 返回： 成功
arn 字符串	指定角色的 Amazon 资源名称 (ARN)。 返回： 始终 示例： "arn:aws:iam::1234567890:role/mynewrole"
assume_role_policy_document 字典	授予实体承担角色权限的策略。 注意：此字典中的键的大小写不再从 CamelCase 转换为 snake_case。此行为在 8.0.0 版本中已更改。 返回： 始终 示例： {"statement": [{"action": "sts:AssumeRole", "effect": "Allow", "principal": {"service": "ec2.amazonaws.com"}, "sid": ""}], "version": "2012-10-17"}
assume_role_policy_document_raw 字典 在 amazon.aws 5.3.0 中添加	注意：此返回值已弃用，将在 2026-05-01 之后的版本中删除。iam_role.assume_role_policy_document 和 iam_role.assume_role_policy_document_raw 现在使用相同的格式。 返回： 始终 示例： {"statement": [{"action": "sts:AssumeRole", "effect": "Allow", "principal": {"service": "ec2.amazonaws.com"}, "sid": ""}], "version": "2012-10-17"}
attached_policies 列表 / 元素=字典	包含附加到该角色的托管 IAM 策略的名称和 ARN 的字典列表。 返回： 始终 示例： [{"policy_arn": "arn:aws:iam::aws:policy/PowerUserAccess", "policy_name": "PowerUserAccess"}]
policy_arn 字符串	指定托管策略的 Amazon 资源名称 (ARN)。 返回： 成功 示例： "arn:aws:iam::123456789012:policy/test_policy"
policy_name 字符串	标识策略的友好名称。 返回： 成功 示例： "test_policy"
create_date 字符串	角色创建的日期和时间，采用 ISO 8601 日期时间格式。 返回： 始终 示例： "2016-08-14T04:36:28+00:00"
描述 字符串	角色的描述。 返回： 始终 示例： "这是 我的 新角色"
max_session_duration 整数	承担角色时会话的最长持续时间（以秒为单位）。 返回： 始终 示例： 3600
路径 字符串	角色的路径。 返回： 始终 示例： "/"
role_id 字符串	标识角色的稳定且唯一的字符串。 返回： 始终 示例： "ABCDEFF4EZ4ABCDEFV4ZC"
role_last_used 字典	包含有关上次使用 IAM 角色时间的信息。 返回： 始终 示例： {"last_used_date": "2023-11-22T21:54:29+00:00", "region": "us-east-2"}
last_used_date 字符串	上次使用角色的日期和时间，采用 ISO 8601 日期时间格式。 返回： 始终
region 字符串	上次使用角色的 Amazon Web Services 区域的名称。 返回： 始终
role_name 字符串	标识角色的友好名称。 返回： 始终 示例： "myrole"
tags 字典	角色标签 返回： 始终 示例： {"Env": "Prod"}

作者

• Rob White (@wimnat)

集合链接

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