iam_group - Управление группами AWS IAM
Новая версия 2.4.
- Обзор
- Требования (к хосту, на котором выполняется модуль)
- Параметры
- Примеры
- Возвращаемые значения
- Примечания
Обзор
- Управление группами 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 |
||
| purge_users |
нет | Отсоединение пользователей, которые не включены в список пользователей |
||
| security_token (добавлено в 1.6)
|
нет | Токен безопасности AWS STS. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. псевдонимы: access_token |
||
| state |
да |
|
Создать или удалить группу IAM |
|
| users |
нет | Список существующих пользователей для добавления в качестве членов группы. |
||
| validate_certs (добавлено в 1.5)
|
нет | да |
|
При значении "нет", сертификаты SSL не будут проверены для версий boto >= 2.6.0. |
Примеры
# Note: These examples do not set authentication details, see the AWS Guide for details.
# Create a group
- iam_group:
name: testgroup1
state: present
# Create a group and attach a managed policy using its ARN
- iam_group:
name: testgroup1
managed_policy:
- arn:aws:iam::aws:policy/AmazonSNSFullAccess
state: present
# Create a group with users as members and attach a managed policy using its ARN
- iam_group:
name: testgroup1
managed_policy:
- arn:aws:iam::aws:policy/AmazonSNSFullAccess
users:
- test_user1
- test_user2
state: present
# Remove all managed policies from an existing group with an empty list
- iam_group:
name: testgroup1
state: present
purge_policy: true
# Remove all group members from an existing group
- iam_group:
name: testgroup1
managed_policy:
- arn:aws:iam::aws:policy/AmazonSNSFullAccess
purge_users: true
state: present
# Delete the group
- iam_group:
name: testgroup1
state: absent
Возвращаемые значения
Общие возвращаемые значения описаны здесь Возвращаемые значения, следующие поля уникальны для данного модуля:
| имя | описание | возвращается | тип | пример | ||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| group | словарь, содержащий всю информацию о группе |
успех | сложный | |||||||||||||||||||||||||||||||
| содержит: |
|
|||||||||||||||||||||||||||||||||
| users | список, содержащий всех участников группы |
успех | сложный | |||||||||||||||||||||||||||||||
| содержит: |
|
|||||||||||||||||||||||||||||||||
Примечания
Примечание
- Если параметры не заданы в модуле, можно использовать следующие переменные окружения в порядке убывания приоритета
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
Статус
Этот модуль помечен как предварительный, что означает, что его интерфейс не гарантируется как обратной совместимый.
Для получения помощи в разработке модулей, если вы захотите, пожалуйста, прочитайте Информация о сообществе и участие, Тестирование Ansible и Разработка модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/iam_group_module.html