amazon.aws.iam_role_info 模块 – 收集 IAM 角色信息

注意

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

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

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

要在剧本中使用它，请指定：amazon.aws.iam_role_info。

community.aws 1.0.0 中的新增功能

概要

• 收集有关 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 之后的版本中删除。
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 回调将输出到剧本期间进行的总列表。 还可以使用 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 之后的版本中删除。
name 别名：role_name 字符串	要搜索的角色的名称。 与 path_prefix 互斥。
path_prefix 别名：path、prefix 字符串	用于限制 IAM 角色搜索的角色前缀。 与 name 互斥。 path 和 prefix 在 7.2.0 版本中添加为别名。 在 2026-05-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 之后的发行版中移除。
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。

示例

- name: find all existing IAM roles
  amazon.aws.iam_role_info:
  register: result

- name: describe a single role
  amazon.aws.iam_role_info:
    name: MyIAMRole

- name: describe all roles matching a path prefix
  amazon.aws.iam_role_info:
    path_prefix: /application/path/

返回值

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

键	描述
iam_roles 复杂	IAM 角色列表。 返回：始终
arn 字符串	IAM 角色的 Amazon 资源名称。 返回：始终 示例："arn:aws:iam::123456789012:role/AnsibleTestRole"
assume_role_policy_document 字典	授予实体承担角色权限的策略。 注意：此字典中键的大小写不再从 CamelCase 转换为 snake_case。此行为在 8.0.0 版本中已更改。 返回：始终
assume_role_policy_document_raw 字典 amazon.aws 5.3.0 中添加	注意：此返回值已弃用，将在 2026-05-01 之后的发行版中移除。iam_roles.assume_role_policy_document 和 iam_roles.assume_role_policy_document_raw 现在使用相同的格式。 返回：始终
create_date 字符串	创建 IAM 角色的日期。 返回：始终 示例："2017-10-23T00:05:08+00:00"
inline_policies 列表 / 元素=字符串	内联策略名称列表。 返回：始终 示例：[]
instance_profiles 复杂	附加的实例配置文件列表。 返回：始终
arn 字符串	实例配置文件的 Amazon 资源名称。 返回：始终 示例："arn:aws:iam::123456789012:instance-profile/AnsibleTestEC2Policy"
create_date 字符串	创建实例配置文件的日期。 返回：始终 示例："2017-10-23T00:05:08+00:00"
instance_profile_id 字符串	实例配置文件的 Amazon 标识符。 返回：始终 示例："AROAII7ABCD123456EFGH"
instance_profile_name 字符串	实例配置文件的名称。 返回：始终 示例："AnsibleTestEC2Policy"
路径 字符串	实例配置文件的路径。 返回：始终 示例："/"
roles 列表 / 元素=字符串	与此实例配置文件关联的角色列表。 返回：始终 示例：[]
managed_policies 复杂	附加的托管策略列表。 返回：始终
policy_arn 字符串	策略的 Amazon 资源名称。 返回：始终 示例："arn:aws:iam::123456789012:policy/AnsibleTestEC2Policy"
policy_name 字符串	托管策略的名称。 返回：始终 示例："AnsibleTestEC2Policy"
路径 字符串	角色的路径。 返回：始终 示例："/"
role_id 字符串	角色的 Amazon 标识符。 返回：始终 示例："AROAII7ABCD123456EFGH"
role_name 字符串	角色的名称。 返回：始终 示例："AnsibleTestRole"
tags 字典	角色标签。 返回：始终 示例：{"Env": "Prod"}

作者

• Will Thames (@willthames)

资源链接

• 问题追踪器
• 代码仓库
• 通信