Spec-Zone.ru › Ansible 2.5

iam_group - Управление группами AWS IAM

Новая версия в 2.4.

  • Обзор
    • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения
  • Статус
    • Автор

Обзор

  • Управление группами AWS IAM

Требования

Ниже перечислены требования к хосту, на котором выполняется этот модуль.

  • boto
  • boto3
  • botocore
  • python >= 2.6

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
aws_access_key По умолчанию:
None
Ключ доступа AWS. Если не задан, используется значение переменной окружения AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY.

Псевдонимы: ec2_access_key, access_key
aws_secret_key По умолчанию:
None
Секретный ключ AWS. Если не задан, используется значение переменной окружения AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY.

Псевдонимы: ec2_secret_key, secret_key
ec2_url По умолчанию:
None
URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех других модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если таковое имеется.
managed_policy
Список ARN управляемых политик или дружественных имен для прикрепления к роли. Для встраивания встроенной политики используйте iam_policy.
name
обязательно
Имя группы, которую нужно создать.
profile
(добавлено в 1.6)
По умолчанию:
None
Использует профиль boto. Работает только с boto >= 2.24.0.
purge_policy По умолчанию:
no
Открепляет политику, которая не включена в список managed_policy.
purge_users По умолчанию:
no
Открепляет пользователей, которые не включены в список пользователей.
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)
По умолчанию:
None
Токен безопасности AWS STS. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN.

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

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

path
строка
путь к группе

Пример:
/
group_id
строка
устойчивая и уникальная строка, идентифицирующая группу

Пример:
AGPAIDBWE12NSFINE55TM
create_date
строка
дата и время создания группы в формате ISO 8601

Пример:
2017-02-08T04:36:28+00:00
arn
строка
Amazon Resource Name (ARN), определяющий группу

Пример:
arn:aws:iam::1234567890:group/testgroup1
group_name
строка
дружественное имя, идентифицирующее группу

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

path
строка
путь к пользователю

Пример:
/
create_date
строка
дата и время создания пользователя в формате ISO 8601

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

Пример:
AIDAIZTPY123YQRS22YU2
arn
строка
Amazon Resource Name (ARN), определяющий пользователя

Пример:
arn:aws:iam::1234567890:user/test_user1
user_name
строка
дружественное имя, идентифицирующее пользователя

Пример:
testgroup1


Статус

Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется как обратной совместимости.

Автор

  • 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.5/modules/iam_group_module.html

Spec-Zone.ru

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