iam_user — Управление пользователями AWS IAM
Впервые добавлена в версии 2.5.
Обзор
- Управление пользователями AWS IAM
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- boto
- boto3
- botocore
- python >= 2.6
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| aws_access_key | Ключ доступа AWS. Если не задан, используется значение переменной окружения AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY.
Псевдонимы: ec2_access_key, access_key |
|
| aws_secret_key | Секретный ключ AWS. Если не задан, используется значение переменной окружения AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY.
Псевдонимы: ec2_secret_key, secret_key |
|
| ec2_url | URL для подключения к облаку EC2 или Eucalyptus (по умолчанию модуль использует адреса EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех других модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если таковая имеется. |
|
| managed_policy | Список ARNs управляемых политик или дружественных имён для добавления к пользователю. Для встраивания политики, используйте iam_policy. |
|
| name
обязательно |
Имя пользователя для создания. |
|
| profile
(добавлен в 1.6) |
Использует профиль boto. Работает только с boto >= 2.24.0. |
|
| purge_policy | По умолчанию: "нет" |
Отсоединить политики, которые не включены в список managed_policy. |
| region | Регион AWS для использования. Если не указан, используется значение переменной окружения AWS_REGION или EC2_REGION, если таковая имеется. См. http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region
Псевдонимы: aws_region, ec2_region |
|
| security_token
(добавлен в 1.6) |
Токен безопасности AWS STS. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN.
Псевдонимы: access_token |
|
| state
обязательно |
|
Создать или удалить пользователя IAM. |
| validate_certs
bool
(добавлен в 1.5) |
|
Если установлено «нет», сертификаты SSL не будут проверены для версий boto >= 2.6.0. |
Примечания
Примечание
- Если параметры не заданы в модуле, могут использоваться следующие переменные окружения в порядке убывания приоритета
AWS_URLилиEC2_URL,AWS_ACCESS_KEY_IDилиAWS_ACCESS_KEYилиEC2_ACCESS_KEY,AWS_SECRET_ACCESS_KEYилиAWS_SECRET_KEYилиEC2_SECRET_KEY,AWS_SECURITY_TOKENилиEC2_SECURITY_TOKEN,AWS_REGIONилиEC2_REGION. - Ansible использует файл конфигурации boto (обычно ~/.boto), если данные о доступе не предоставлены. См. http://boto.readthedocs.org/en/latest/boto_config_tut.html
-
AWS_REGIONилиEC2_REGIONобычно могут использоваться для указания региона AWS, когда это необходимо, но это также можно настроить в файле конфигурации boto
Примеры
# 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 `iam_group`,
# as users belong to them.
# Create a user
- iam_user:
name: testuser1
state: present
# Create a user and attach a managed policy using its ARN
- iam_user:
name: testuser1
managed_policy:
- arn:aws:iam::aws:policy/AmazonSNSFullAccess
state: present
# Remove all managed policies from an existing user with an empty list
- iam_user:
name: testuser1
state: present
purge_policy: true
# Delete the user
- iam_user:
name: testuser1
state: absent
Возвращаемые значения
Общие возвращаемые значения описаны в разделе. Ниже приведены поля, уникальные для данного модуля:
| Ключ | Возвращаемое значение | Описание | |
|---|---|---|---|
| user
сложный |
успех | словарь, содержащий всю информацию о пользователе
|
|
| arn
строка |
Amazon Resource Name (ARN), определяющий пользователя
Пример:
arn:aws:iam::1234567890:user/testuser1 |
||
| create_date
строка |
дата и время создания пользователя в формате ISO 8601
Пример:
2017-02-08T04:36:28+00:00 |
||
| user_id
строка |
уникальная строка, идентифицирующая пользователя
Пример:
AGPAIDBWE12NSFINE55TM |
||
| user_name
строка |
дружественное имя, идентифицирующее пользователя
Пример:
testuser1 |
||
| path
строка |
путь к пользователю
Пример:
/ |
||
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется как обратной совместимости.
Техническое сопровождение
Этот модуль помечен как сообщество, что означает, что он поддерживается сообществом Ansible. См. Техническое сопровождение модулей и поддержка для получения дополнительной информации.
Список других модулей, также поддерживаемых сообществом Ansible, см. здесь.
Автор
- Josh Souza, @joshsouza
Подсказка
Если вы заметите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.6/modules/iam_user_module.html