community.aws.iam_group – Управление группами AWS IAM
Примечание
Этот плагин входит в коллекцию community.aws (версия 1.3.0).
Для его установки используйте: ansible-galaxy collection install community.aws.
Для использования в книге задач укажите: community.aws.iam_group.
Введено в версии 1.0.0: для community.aws
Обзор
- Управление группами AWS IAM.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- boto
- boto3
- botocore
- python >= 2.6
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| aws_access_key строка | Ключ доступа AWS. Если не задано, используется значение переменной среды AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY. Если параметр profile задан, этот параметр игнорируется. Одновременное указание параметров aws_access_key и profile устарело и параметры будут сделаны взаимоисключающими после 2022-06-01. псевдонимы: ec2_access_key, access_key | |
| aws_ca_bundle путь | Расположение файла сертификатов доверенных центров выдачи сертификатов (CA bundle) для проверки SSL-сертификатов. Используется только для модулей на основе boto3. Примечание: файл CA Bundle считывается со стороны модуля и может потребоваться явно скопировать его с контроллера, если он не выполняется локально. | |
| aws_config словарь | Словарь для изменения конфигурации botocore. Параметры можно найти по адресу https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. Для модулей boto используется только ключ 'user_agent'. Дополнительные параметры конфигурации boto см. по адресу http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto. | |
| aws_secret_key строка | Секретный ключ AWS. Если не задан, используется значение переменной среды AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY. Если параметр profile задан, этот параметр игнорируется. Одновременное указание параметров aws_secret_key и profile устарело и параметры будут сделаны взаимоисключающими после 2022-06-01. псевдонимы: ec2_secret_key, secret_key | |
| debug_botocore_endpoint_logs логический тип |
| Используйте logger botocore.endpoint для анализа уникальных (а не общих) API-вызовов «ресурс:действие» во время задачи, выводив набор в ключ resource_actions в результатах задачи. Используйте callback aws_resource_action для вывода полного списка, сделанного во время книги задач. Переменная среды ANSIBLE_DEBUG_BOTOCORE_LOGS также может быть использована. |
| ec2_url строка | URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где необходим регион. Должен быть указан для всех других модулей, если регион не используется. Если не задано, используется значение переменной среды EC2_URL, если она есть. псевдонимы: aws_endpoint_url, endpoint_url | |
| managed_policies список / элементы=строка | Список ARNs управляемых политик или дружественных имён для добавления к роли. Для встраивания политики встраиваемого типа используйте community.aws.iam_policy. псевдонимы: managed_policy | |
| name строка / обязательный параметр | Имя группы, которую нужно создать. | |
| profile строка | Использует профиль boto. Работает только с boto >= 2.24.0. Использование параметра profile переопределит параметры aws_access_key, aws_secret_key и security_token, и поддержка их одновременного указания с profile устарела. aws_access_key, aws_secret_key и security_token будут сделаны взаимоисключающими с profile после 2022-06-01. псевдонимы: aws_profile | |
| purge_policies логический тип |
| Если purge_policies=true, любые управляемые политики, не перечисленные в managed_policies, будут откреплены. псевдонимы: purge_policy, purge_managed_policies |
| purge_users логический тип |
| Если purge_users=true, пользователи, не включённые в users, будут откреплены. |
| region строка | Регион AWS для использования. Если не указан, используется значение переменной среды AWS_REGION или EC2_REGION, если она есть. См. http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region
псевдонимы: aws_region, ec2_region | |
| security_token строка | Токен безопасности AWS STS. Если не задан, используется значение переменной среды AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. Если параметр profile задан, этот параметр игнорируется. Одновременное указание параметров security_token и profile устарело и параметры будут сделаны взаимоисключающими после 2022-06-01. псевдонимы: aws_security_token, access_token | |
| state строка / обязательный параметр |
| Создание или удаление группы IAM. |
| users список / элементы=строка | Список существующих пользователей для добавления в члены группы. | |
| validate_certs логический тип |
| Если установлено значение "нет", SSL-сертификаты не будут проверены для версий boto >= 2.6.0. |
Примечания
Примечание
- Если параметры не заданы в модуле, можно использовать следующие переменные среды в порядке убывания приоритета
AWS_URLилиEC2_URL,AWS_PROFILEилиAWS_DEFAULT_PROFILE,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,AWS_CA_BUNDLE - Ansible использует конфигурационный файл boto (обычно ~/.boto), если учетные данные не предоставлены. См. https://boto.readthedocs.io/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.
- name: Create a group
community.aws.iam_group:
name: testgroup1
state: present
- name: Create a group and attach a managed policy using its ARN
community.aws.iam_group:
name: testgroup1
managed_policies:
- arn:aws:iam::aws:policy/AmazonSNSFullAccess
state: present
- name: Create a group with users as members and attach a managed policy using its ARN
community.aws.iam_group:
name: testgroup1
managed_policies:
- arn:aws:iam::aws:policy/AmazonSNSFullAccess
users:
- test_user1
- test_user2
state: present
- name: Remove all managed policies from an existing group with an empty list
community.aws.iam_group:
name: testgroup1
state: present
purge_policies: true
- name: Remove all group members from an existing group
community.aws.iam_group:
name: testgroup1
managed_policies:
- arn:aws:iam::aws:policy/AmazonSNSFullAccess
purge_users: true
state: present
- name: Delete the group
community.aws.iam_group:
name: testgroup1
state: absent
Значения возврата
Общие значения возврата документированы здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание | ||
|---|---|---|---|---|
| iam_group сложный | успешно | словарь, содержащий всю информацию о группе, включая состав группы | ||
| group сложный | успешно | словарь, содержащий всю информацию о группе | ||
| arn строка | успешно | Amazon Resource Name (ARN), определяющий группу Пример: arn:aws:iam::1234567890:group/testgroup1 | ||
| create_date строка | успешно | дата и время создания группы в формате ISO 8601 Пример: 2017-02-08T04:36:28+00:00 | ||
| group_id строка | успешно | уникальная и стабильная строка, идентифицирующая группу Пример: AGPAIDBWE12NSFINE55TM | ||
| group_name строка | успешно | название группы для удобства идентификации Пример: testgroup1 | ||
| path строка | успешно | путь к группе Пример: / | ||
| users сложный | успешно | список, содержащий всех участников группы | ||
| arn строка | успешно | Amazon Resource Name (ARN), определяющий пользователя Пример: arn:aws:iam::1234567890:user/test_user1 | ||
| create_date строка | успешно | дата и время создания пользователя в формате ISO 8601 Пример: 2017-02-08T04:36:28+00:00 | ||
| path строка | успешно | путь к пользователю Пример: / | ||
| user_id строка | успешно | уникальная и стабильная строка, идентифицирующая пользователя Пример: AIDAIZTPY123YQRS22YU2 | ||
| user_name строка | успешно | название пользователя для удобства идентификации Пример: testgroup1 | ||
Авторы
- Nick Aslanidis (@naslanidis)
- Maksym Postument (@infectsoldier)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/aws/iam_group_module.html
