Модуль amazon.aws.iam_user — управление пользователями AWS IAM

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install amazon.aws. Для использования этого модуля необходимы дополнительные требования; подробности см. в разделе Требования.

Чтобы использовать его в плейбуке, укажите: 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.35.0
botocore >= 1.35.0

Параметры

Параметр	Комментарии
access_key псевдонимы: aws_access_key_id, aws_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` (в порядке убывания приоритета). Параметры aws_access_key и profile являются взаимоисключающими. Псевдоним aws_access_key_id добавлен в выпуске 5.1.0 для согласованности с AWS botocore SDK.
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.
boundary псевдонимы: boundary_policy_arn, permissions_boundary строка добавлено в amazon.aws 7.2.0	ARN управляемой политики IAM, применяемой к этому пользователю в качестве граничной политики. Граничные политики можно использовать для ограничения разрешений, которыми может пользоваться пользователь, но сами по себе они не предоставляют никаких разрешений. Дополнительные сведения о граничных политиках см. по адресу https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html. Установите пустую строку `""`, чтобы удалить граничную политику.
debug_botocore_endpoint_logs логическое значение	Использовать регистратор `botocore.endpoint` для анализа уникальных (а не общего количества) вызовов API `"resource:action"`, выполненных во время задачи, и выводить их набор в ключ resource_actions результатов задачи. Используйте callback `aws_resource_action`, чтобы вывести общий список вызовов, выполненных в ходе плейбука. Также можно использовать переменную окружения `ANSIBLE_DEBUG_BOTOCORE_LOGS`. Варианты: `false` ← (по умолчанию) `true`
endpoint_url псевдонимы: aws_endpoint_url строка	URL для подключения вместо конечных точек AWS по умолчанию. Хотя этот параметр можно использовать для подключения к другим совместимым с AWS сервисам, коллекции amazon.aws и community.aws тестируются только с AWS. Также можно использовать переменную окружения `AWS_URL`.
managed_policies псевдоним: managed_policy список / элементы=строка	Список ARN или понятных имен управляемых политик, прикрепляемых к пользователю. Чтобы встроить встроенную политику, используйте community.aws.iam_policy. По умолчанию: `[]`
name псевдоним: user_name строка / обязательный	Имя пользователя. Примечание: имена пользователей должны быть уникальны в пределах учетной записи. Пути (`path`) не влияют на требования уникальности для `name`. Например, в одной учетной записи не допускается наличие одновременно `/Path1/MyUser` и `/Path2/MyUser`. `user_name` добавлен в качестве псевдонима в выпуске 7.2.0.
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 и session_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 строка	Регион AWS для использования. Для глобальных сервисов, таких как IAM, Route53 и CloudFront, параметр region игнорируется. Также можно использовать переменную окружения `AWS_REGION`. Дополнительные сведения см. в документации Amazon AWS: http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region.
remove_password логическое значение добавлено в community.aws 2.2.0	Параметр для удаления паролей входа пользователя. Этот параметр взаимоисключающий с `password`. Варианты: `false` `true`
secret_key псевдонимы: aws_secret_access_key, aws_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` (в порядке убывания приоритета). Параметры secret_key и profile являются взаимоисключающими. Псевдоним aws_secret_access_key добавлен в выпуске 5.1.0 для согласованности с AWS botocore SDK.
session_token псевдоним: aws_session_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`. Параметры session_token и profile являются взаимоисключающими.
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`, SSL-сертификаты не будут проверяться при обмене данными с API AWS. Настоятельно не рекомендуется устанавливать validate_certs=false; вместо этого рассмотрите возможность использования aws_ca_bundle. Варианты: `false` `true` ← (по умолчанию)
wait логическое значение добавлено в community.aws 2.2.0	Если `wait=True`, модуль будет ожидать создания пользователя IAM до `wait_timeout` секунд, прежде чем вернуть управление. Варианты: `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 complex	Словарь со всей информацией о пользователе. Возвращается: success
arn string	Имя ресурса Amazon (ARN), указывающее на пользователя. Возвращается: всегда Пример: `"arn:aws:iam::123456789012:user/testuser1"`
attached_policies list / elements=dictionary добавлено в amazon.aws 7.2.0	Список с основной информацией об управляемых политиках, прикрепленных к группе. Возвращается: всегда Пример: `[{"policy_arn": "arn:aws:iam::123456789012:policy/test_policy", "policy_name": "test_policy"}]`
policy_arn string	Имя ресурса Amazon (ARN), указывающее на управляемую политику. Возвращается: success Пример: `"arn:aws:iam::123456789012:policy/test_policy"`
policy_name string	Понятное имя, идентифицирующее политику. Возвращается: success Пример: `"test_policy"`
create_date string	Дата и время создания пользователя в формате даты и времени ISO 8601. Возвращается: всегда Пример: `"2017-02-08T04:36:28+00:00"`
path string	Путь к пользователю. Возвращается: всегда Пример: `"/"`
tags dictionary	Теги пользователя. Возвращается: всегда Пример: `{"Env": "Prod"}`
user_id string	Стабильная и уникальная строка, идентифицирующая пользователя. Возвращается: всегда Пример: `"AGPA12345EXAMPLE54321"`
user_name string	Понятное имя, идентифицирующее пользователя. Возвращается: всегда Пример: `"testuser1"`

Авторы

Josh Souza (@joshsouza)

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

© 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_module.html