Модуль amazon.aws.iam_user_info — сбор сведений о пользователях IAM в AWS
Примечание
Этот модуль входит в коллекцию amazon.aws (версия 11.3.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install amazon.aws. Для использования этого модуля могут потребоваться дополнительные компоненты; подробности см. в разделе Требования.
Чтобы использовать его в плейбуке, укажите: amazon.aws.iam_user_info.
Добавлено в amazon.aws 5.0.0
Обзор
- Этот модуль предназначен для сбора сведений о пользователях IAM в AWS.
- Модуль впервые добавлен в
community.awsв выпуске 1.0.0.
Требования
Следующие требования должны быть выполнены на хосте, выполняющем этот модуль.
- python >= 3.6
- boto3 >= 1.35.0
- botocore >= 1.35.0
Параметры
Параметр | Описание |
|---|---|
access_key aliases: aws_access_key_id, aws_access_key string | Идентификатор ключа доступа AWS. Дополнительную информацию о токенах доступа см. в документации AWS: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также можно использовать переменные среды Параметры aws_access_key и profile взаимоисключающие. Псевдоним aws_access_key_id добавлен в выпуске 5.1.0 для соответствия AWS botocore SDK. |
aws_ca_bundle path | Путь к пакету сертификатов CA, используемому при проверке SSL-сертификатов. Также можно использовать переменную среды |
aws_config dictionary | Словарь для изменения конфигурации botocore. Параметры описаны в документации AWS: https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. |
debug_botocore_endpoint_logs boolean | Использовать регистратор Также можно использовать переменную среды Варианты:
|
endpoint_url aliases: aws_endpoint_url string | URL для подключения вместо стандартных конечных точек AWS. Хотя этот параметр можно использовать для подключения к другим сервисам, совместимым с AWS, коллекции amazon.aws и community.aws тестируются только с AWS. Также можно использовать переменную среды |
group aliases: group_name string | Название группы пользователя IAM, которого нужно найти. Не может использоваться одновременно с
|
name aliases: user_name string | Имя пользователя IAM, которого нужно найти.
|
path_prefix aliases: path, prefix string | Путь к пользователю IAM. Не может использоваться одновременно с Если указано значение, будут возвращены имена всех пользователей, путь которых начинается с заданного значения. По умолчанию: |
profile aliases: aws_profile string | Именованный профиль AWS для аутентификации. Дополнительную информацию об именованных профилях см. в документации AWS: https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html. Также можно использовать переменную среды Параметр profile взаимоисключающий с параметрами aws_access_key, aws_secret_key и session_token. |
region aliases: aws_region string | Регион AWS. Для глобальных сервисов, таких как IAM, Route53 и CloudFront, параметр region игнорируется. Также можно использовать переменную среды Дополнительную информацию см. в документации Amazon AWS: http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region. |
secret_key aliases: aws_secret_access_key, aws_secret_key string | Секретный ключ доступа AWS. Дополнительную информацию о токенах доступа см. в документации AWS: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также можно использовать переменные среды Параметры secret_key и profile взаимоисключающие. Псевдоним aws_secret_access_key добавлен в выпуске 5.1.0 для соответствия AWS botocore SDK. |
session_token aliases: aws_session_token string | Токен сеанса AWS STS для использования с временными учетными данными. Дополнительную информацию о токенах доступа см. в документации AWS: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также можно использовать переменную среды Параметры session_token и profile взаимоисключающие. |
validate_certs boolean | Если задано значение Настоятельно не рекомендуется задавать validate_certs=false; вместо этого рассмотрите возможность использования aws_ca_bundle. Варианты:
|
Примечания
Примечание
- Внимание: Для модулей переменные среды и файлы конфигурации считываются из контекста «хоста» 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 complex | Список подходящих пользователей IAM. Возвращается: всегда |
|
arn string |
ARN пользователя. Возвращается: если пользователь существует. Пример: |
|
create_date string |
Дата и время создания пользователя. Возвращается: если пользователь существует. Пример: |
|
login_profile dictionary |
Подробные сведения о профиле входа, если пользователь может войти через стандартную консоль AWS. Если доступ отсутствует, возвращается пустой объект {}. Возвращается: если пользователь существует. Пример: |
|
create_date string |
Дата и время создания пользователя в формате даты и времени ISO 8601. Возвращается: всегда |
|
password_reset_required boolean |
Указывает, должен ли пользователь задать новый пароль при следующем входе. Возвращается: всегда |
|
user_name string |
Имя пользователя IAM Возвращается: всегда |
|
password_last_used string |
Дата и время последнего использования пароля пользователем. Возвращается: если пароль использовался хотя бы один раз Пример: |
|
path string |
Путь к пользователю. Возвращается: если пользователь существует. Пример: |
|
tags dictionary |
Теги пользователя. Возвращается: если пользователь существует. Пример: |
|
user_id string |
Уникальный идентификатор пользователя. Возвращается: если пользователь существует. Пример: |
|
user_name string |
Имя пользователя. Возвращается: если пользователь существует. Пример: |
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/amazon/aws/iam_user_info_module.html