Spec-Zone.ru › Ansible 2.8

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
debug_botocore_endpoint_logs
логический тип
добавлено в 2.8
    Варианты:
  • нет ←
  • да
Используйте logger botocore.endpoint для анализа уникальных (а не общих) API-вызовов «ресурс:действие», выполненных во время задачи, выводимых в ключ resource_actions результатов задачи. Используйте callback aws_resource_action для вывода полного списка, созданного во время выполнения playbook. Также можно использовать переменную среды ANSIBLE_DEBUG_BOTOCORE_LOGS.
ec2_url
строка
URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех остальных модулей, если не используется регион. Если не задан, используется значение переменной среды EC2_URL, если она задана.
managed_policy
-
Список ARNs управляемых политик или дружественных имён для добавления к роли. Для встраивания встроенной политики используйте iam_policy.
name
- / требуется
Имя группы, которую нужно создать.
profile
строка
Использует профиль boto. Работает только с boto >= 2.24.0.
purge_policy
логический тип
    Варианты:
  • нет ←
  • да
Отсоединить политику, которая не включена в список managed_policy
purge_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.

псевдонимы: access_token
state
- / требуется
    Варианты:
  • present
  • absent
Создание или удаление группы IAM
users
-
Список существующих пользователей, которые должны быть добавлены в члены группы.
validate_certs
логический тип
    Варианты:
  • нет
  • да ←
При значении «нет» сертификаты 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), если учетные данные не предоставлены. См. 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.

# 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
complex
success
словарь, содержащий всю информацию о группе

arn
string
Amazon Resource Name (ARN), определяющий группу

Пример:
arn:aws:iam::1234567890:group/testgroup1
create_date
string
дата и время создания группы в формате ISO 8601

Пример:
2017-02-08T04:36:28+00:00
group_id
string
уникальная строка, идентифицирующая группу

Пример:
AGPAIDBWE12NSFINE55TM
group_name
string
название группы для удобства идентификации

Пример:
testgroup1
path
string
путь к группе

Пример:
/
users
complex
success
список, содержащий всех участников группы

arn
string
Amazon Resource Name (ARN), определяющий пользователя

Пример:
arn:aws:iam::1234567890:user/test_user1
create_date
string
дата и время создания пользователя в формате ISO 8601

Пример:
2017-02-08T04:36:28+00:00
path
string
путь к пользователю

Пример:
/
user_id
string
уникальная строка, идентифицирующая пользователя

Пример:
AIDAIZTPY123YQRS22YU2
user_name
string
имя пользователя для удобства идентификации

Пример:
testgroup1


Статус

  • Этот модуль не гарантирует обратной совместимости интерфейса. [превью]
  • Этот модуль поддерживается сообществом Ansible. [community]

Авторы

  • Nick Aslanidis (@naslanidis)
  • Maksym Postument (@infectsoldier)

Подсказка

Если вы заметили какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/iam_group_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API