Spec-Zone.ru › Ansible 2.7

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
-
По умолчанию:
"нет"
Удаление пользователей, не включенных в список пользователей
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
AWS STS токен безопасности. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN.

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

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


Статус

  • Этот модуль не гарантирует обратную совместимость интерфейса. [preview]
  • Этот модуль поддерживается Сообществом 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.7/modules/iam_group_module.html

Spec-Zone.ru

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