Spec-Zone.ru › Ansible

amazon.aws.iam_user_info модуль — Сбор фактов об IAM-пользователе(ях) в AWS

Примечание

Этот модуль является частью коллекции amazon.aws (версия 8.2.1).

Возможно, эта коллекция уже установлена, если вы используете пакет 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.26.0
  • botocore >= 1.29.0
END_OF_DOCUMENT_MARKER

Параметры

Параметр

Комментарии

access_key

псевдонимы: aws_access_key_id, aws_access_key, ec2_access_key

строка

Идентификатор ключа доступа AWS.

См. документацию 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_access_key_id был добавлен в релизе 5.1.0 для согласованности с SDK AWS botocore.

Псевдоним ec2_access_key устарел и будет удален в релизе после 2024-12-01.

Поддержка переменной среды EC2_ACCESS_KEY устарела и будет удалена в релизе после 2024-12-01.

aws_ca_bundle

путь

Расположение файла CA-сертификатов для проверки SSL-сертификатов.

Также может быть использована переменная среды 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

строка

URL для подключения вместо стандартных AWS-точек входа. Хотя это можно использовать для подключения к другим совместимым с 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_secret_access_key был добавлен в релизе 5.1.0 для согласованности с SDK AWS botocore.

Псевдоним ec2_secret_key устарел и будет удален в релизе после 2024-12-01.

Поддержка переменной среды EC2_SECRET_KEY устарела и будет удалена в релизе после 2024-12-01.
END_OF_DOCUMENT_MARKER

session_token

aliases: aws_session_token, security_token, aws_security_token, access_token

string

Токен сеанса 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, а параметр был переименован из security_token в session_token в релизе 6.0.0.

Алиасы security_token, aws_security_token и access_token устарели и будут удалены в релизе после 2024-12-01.

Поддержка переменных среды EC2_SECRET_KEY и AWS_SECURITY_TOKEN устарела и будет удалена в релизе после 2024-12-01.

validate_certs

boolean

При установке в false, сертификаты SSL для связи с API AWS не будут проверены.

Установка validate_certs=false категорически не рекомендуется, в качестве альтернативы, рассмотрите установку aws_ca_bundle вместо этого.

Варианты:

  • false
  • true ← (по умолчанию)

Примечания

Примечание

  • Внимание: Для модулей переменные среды и конфигурационные файлы читаются из контекста хоста Ansible, а не контекста контроллера. Таким образом, файлы, возможно, потребуется скопировать в хост. Для плагинов поиска и подключения переменные среды и конфигурационные файлы читаются из контекста контроллера Ansible, а не контекста хоста.
  • AWS SDK (boto3), используемый Ansible, также может читать значения по умолчанию для учетных данных и других параметров, таких как регион, из своих конфигурационных файлов в контексте хоста 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

строка

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"

path

строка

Путь к пользователю.

Возвращается: при существовании пользователя.

Пример: "/dev/"

tags

словарь

Теги пользователя.

Возвращается: при существовании пользователя.

Пример: {"Env": "Prod"}

user_id

строка

Уникальный идентификатор пользователя.

Возвращается: при существовании пользователя.

Пример: "AIDUIOOCQKTUGI6QJLGH2"

user_name

строка

Имя пользователя.

Возвращается: при существовании пользователя.

Пример: "test_user"

Авторы

  • Constantin Bugneac (@Constantin07)
  • Abhijeet Kasurde (@Akasurde)

Ссылки на коллекцию

  • Система отслеживания ошибок
  • Репозиторий (источники)
  • Связь

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/amazon/aws/iam_user_info_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API