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

Примечание

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

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

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

Для использования в playbook укажите: 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.26.0
botocore >= 1.29.0

END_OF_DOCUMENT_MARKER

Параметры

Параметр	Комментарии
access_key aliases: aws_access_key_id, aws_access_key, ec2_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_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 path	Расположение пакета CA, используемого при проверке SSL-сертификатов. Переменная среды `AWS_CA_BUNDLE` также может использоваться.
aws_config dictionary	Словарь для изменения конфигурации botocore. Параметры можно найти в документации AWS https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.
boundary aliases: boundary_policy_arn, permissions_boundary string добавлено в amazon.aws 7.2.0	ARN управляемой политики IAM, применяемой в качестве политики границы для этого пользователя. Политики границ могут использоваться для ограничения разрешений, которые может использовать пользователь, но сами по себе не предоставляют никаких политик. Для получения дополнительной информации о границах см. https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html. Установите пустую строку `""` для удаления политики границы.
debug_botocore_endpoint_logs boolean	Использовать `botocore.endpoint` регистратор для анализа уникальных (а не общих) `"resource:action"` вызовов API, сделанных во время задачи, выводя набор в ключ resource_actions в результатах задачи. Используйте обратный вызов `aws_resource_action` для вывода в общий список, сделанный во время playbook. Переменная среды `ANSIBLE_DEBUG_BOTOCORE_LOGS` также может использоваться. Варианты: `false` ← (по умолчанию) `true`
endpoint_url aliases: ec2_url, aws_endpoint_url, s3_url string	URL для подключения вместо стандартных конечных точек AWS. Хотя это может использоваться для подключения к другим совместимым с AWS сервисам, коллекции amazon.aws и community.aws тестируются только с AWS. Переменные среды `AWS_URL` или `EC2_URL` также могут использоваться в порядке убывания предпочтения. Псевдонимы ec2_url и s3_url устарели и будут удалены в релизе после 2024-12-01. Поддержка переменной среды `EC2_URL` устарела и будет удалена в релизе после 2024-12-01.
managed_policies aliases: managed_policy list / elements=string	Список ARN или понятных имен управляемых политик для прикрепления к пользователю. Чтобы внедрить встроенную политику, используйте community.aws.iam_policy. По умолчанию: `[]`
name aliases: user_name string / required	Имя пользователя. Примечание: имена пользователей уникальны в пределах учетной записи. Пути (`path`) не влияют на требования уникальности `name`. Например, недопустимо иметь как `/Path1/MyUser`, так и `/Path2/MyUser` в одной учетной записи. `user_name` был добавлен как псевдоним в релизе 7.2.0.
password string добавлено в community.aws 2.2.0	Пароль для применения к пользователю.
password_reset_required boolean добавлено в community.aws 3.1.0	Определяет, требуется ли пользователю установить новый пароль при входе в систему. Игнорируется, если не установлен новый пароль. Варианты: `false` ← (по умолчанию) `true`
path aliases: prefix, path_prefix string добавлено в amazon.aws 7.2.0	Путь для пользователя. Для получения дополнительной информации о путях IAM см. документацию по идентификаторам IAM AWS https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html.
profile aliases: aws_profile string	Именованный профиль 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.

purge_policies aliases: purge_policy, purge_managed_policies boolean	Когда `purge_policies=true`, любые управляемые политики, не указанные в `managed_policies`, будут откреплены. Варианты: `false` ← (по умолчанию) `true`
purge_tags boolean	Если 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 aliases: aws_region, ec2_region string	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.
remove_password boolean added in community.aws 2.2.0	Вариант для удаления паролей входа пользователя. Это поле взаимоисключающее с `password`. Варианты: `false` `true`
secret_key aliases: aws_secret_access_key, aws_secret_key, ec2_secret_key string	Секретный ключ доступа 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.
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.
state string / обязательно	Создание или удаление пользователя IAM. Варианты: `"present"` `"absent"`
tags aliases: resource_tags словарь	Словарь, представляющий теги, которые должны быть применены к ресурсу. Если параметр tags не задан, теги не будут изменены.
update_password строка added in community.aws 2.2.0	Когда обновлять пароли пользователей. `update_password=always` гарантирует, что пароль будет установлен в `password`. `update_password=on_create` будет устанавливать пароль только для вновь созданных пользователей. Варианты: `"always"` ← (по умолчанию) `"on_create"`
validate_certs boolean	При установке в значение `false`, сертификаты SSL для связи с API AWS не будут проверены. Установка validate_certs=false категорически не рекомендуется. В качестве альтернативы, рассмотрите возможность установки aws_ca_bundle вместо этого. Варианты: `false` `true` ← (по умолчанию)
wait boolean added in community.aws 2.2.0	Когда `wait=True`, модуль будет ожидать до `wait_timeout` секунд создания пользователя IAM перед возвратом. Варианты: `false` `true` ← (по умолчанию)

wait_timeout

integer

added in community.aws 2.2.0

Сколько времени (в секундах) ждать завершения создания/обновлений.

По умолчанию: 120

Примечания

Примечание

Поддержка tags и purge_tags была добавлена в релизе 2.1.0.
Внимание: Для модулей переменные среды и конфигурационные файлы считываются из контекста Ansible ‘host’, а не ‘controller’. Поэтому, возможно, потребуется явно скопировать файлы на ‘host’. Для плагинов lookup и connection переменные среды и конфигурационные файлы считываются из контекста Ansible ‘controller’, а не ‘host’.
AWS SDK (boto3), используемый Ansible, также может считывать значения по умолчанию для учетных данных и других настроек, таких как регион, из своих конфигурационных файлов в контексте Ansible ‘host’ (обычно ~/.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 Resource Name (ARN), определяющий пользователя. Возвращается: всегда Пример: `"arn:aws:iam::123456789012:user/testuser1"`
attached_policies list / elements=dictionary added in amazon.aws 7.2.0	Список, содержащий основную информацию о прикрепленных к группе управляемых политиках. Возвращается: всегда Пример: `[{"policy_arn": "arn:aws:iam::123456789012:policy/test_policy", "policy_name": "test_policy"}]`
policy_arn string	Amazon Resource Name (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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/amazon/aws/iam_user_module.html