Spec-Zone.ru › Ansible

Модуль amazon.aws.iam_group – Управление группами AWS IAM

Примечание

Этот модуль входит в коллекцию amazon.aws (версия 8.2.1).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Чтобы установить её, используйте: ansible-galaxy collection install amazon.aws. Для использования этого модуля необходимы дополнительные требования. Подробности см. в разделе Требования.

Для использования в плейбуке укажите: amazon.aws.iam_group.

Новое в community.aws 1.0.0

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

Описание

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

Требования

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

  • python >= 3.6
  • boto3 >= 1.26.0
  • botocore >= 1.29.0

Параметры

Параметр

Комментарии

access_key

псевдонимы: aws_access_key_id, aws_access_key, ec2_access_key

строка

Идентификатор ключа доступа AWS.

См. документацию AWS для получения дополнительной информации о токенах доступа https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys.

Также можно использовать переменные среды AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY в порядке убывания приоритета.

Параметры aws_access_key и profile взаимоисключающие.

Псевдоним aws_access_key_id был добавлен в релизе 5.1.0 для согласованности с SDK AWS botocore.

Псевдоним ec2_access_key устарел и будет удалён в релизе после 2024-12-01.

Поддержка переменной среды EC2_ACCESS_KEY устарела и будет удалена в релизе после 2024-12-01.

aws_ca_bundle

путь

Путь к файлу сертификата CA для проверки SSL-сертификатов.

Также можно использовать переменную среды AWS_CA_BUNDLE.

aws_config

словарь

Словарь для изменения конфигурации botocore.

Параметры можно найти в документации AWS https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.

debug_botocore_endpoint_logs

булево

Использовать botocore.endpoint логгер для анализа уникальных (а не общих) "resource:action" API-вызовов, сделанных во время задачи, выводить набор в ключ resource_actions в результатах задачи. Используйте aws_resource_action обратный вызов для вывода в список всех вызовов, сделанных во время выполнения книги задач.

Также можно использовать переменную среды ANSIBLE_DEBUG_BOTOCORE_LOGS.

Варианты:

  • false ← (по умолчанию)
  • true

endpoint_url

псевдонимы: ec2_url, aws_endpoint_url, s3_url

строка

URL для подключения вместо стандартных конечных точек AWS. Хотя это можно использовать для подключения к другим совместимым с AWS службам, коллекции amazon.aws и community.aws протестированы только с AWS.

Также можно использовать переменные среды AWS_URL или EC2_URL в порядке убывания приоритета.

Псевдонимы ec2_url и s3_url устарели и будут удалены в релизе после 2024-12-01.

Поддержка переменной среды EC2_URL устарела и будет удалена в релизе после 2024-12-01.

managed_policies

псевдонимы: managed_policy

список / элементы=строка

Список ARNs или удобных имён управляемых политик для подключения к роли.

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

Для добавления встроенной политики используйте amazon.aws.iam_policy.

По умолчанию: []

name

псевдонимы: group_name

строка / обязательно

Имя группы.

Примечание: Имена групп уникальны в пределах учётной записи. Пути (path) не влияют на требования уникальности name. Например, нельзя иметь одновременно /Path1/MyGroup и /Path2/MyGroup в одной учётной записи.

Псевдоним group_name был добавлен в релизе 7.2.0.

path

псевдонимы: prefix, path_prefix

строка

добавлено в amazon.aws 7.1.0

Путь к группе.

Дополнительную информацию о путях IAM см. в документации AWS IAM об идентификаторах https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html.

profile

псевдонимы: aws_profile

строка

Используемый профиль AWS для аутентификации.

См. документацию AWS для получения дополнительной информации о профилях https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html.

Также можно использовать переменную среды AWS_PROFILE.

Параметр profile взаимоисключающий с параметрами aws_access_key, aws_secret_key и security_token.

purge_policies

псевдонимы: purge_policy, purge_managed_policies

булево

Если purge_policies=true, все управляемые политики, не указанные в managed_policies, будут отключены.

Варианты:

  • false ← (по умолчанию)
  • true

purge_users

булево

Если purge_users=true, пользователи, не включенные в users, будут отключены.

Варианты:

  • false ← (по умолчанию)
  • true

регион

псевдонимы: aws_region, ec2_region

строка

AWS регион для использования.

Для глобальных служб, таких как IAM, Route53 и CloudFront, регион игнорируется.

Также могут быть использованы переменные среды AWS_REGION или EC2_REGION.

Дополнительную информацию см. в документации Amazon AWS по http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region.

Псевдоним ec2_region устарел и будет удален в релизе после 2024-12-01

Поддержка переменной среды EC2_REGION устарела и будет удалена в релизе после 2024-12-01.

secret_key

псевдонимы: aws_secret_access_key, aws_secret_key, ec2_secret_key

строка

Секретный ключ доступа AWS.

Дополнительную информацию о маркерах доступа см. в документации AWS по https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys.

Также могут быть использованы переменные среды AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, или EC2_SECRET_KEY в порядке убывания предпочтения.

Параметры secret_key и profile взаимоисключающие.

Псевдоним aws_secret_access_key был добавлен в релизе 5.1.0 для согласованности с AWS botocore SDK.

Псевдоним ec2_secret_key устарел и будет удален в релизе после 2024-12-01.

Поддержка переменной среды EC2_SECRET_KEY устарела и будет удалена в релизе после 2024-12-01.

session_token

псевдонимы: aws_session_token, security_token, aws_security_token, access_token

строка

Токен сеанса AWS STS для использования с временными учетными данными.

Дополнительную информацию о маркерах доступа см. в документации AWS по https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys.

Также могут быть использованы переменные среды AWS_SESSION_TOKEN, AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN в порядке убывания предпочтения.

Параметры security_token и profile взаимоисключающие.

Псевдонимы aws_session_token и session_token были добавлены в релизе 3.2.0, а параметр был переименован из security_token в session_token в релизе 6.0.0.

Псевдонимы security_token, aws_security_token и access_token устарели и будут удалены в релизе после 2024-12-01.

Поддержка переменных среды EC2_SECRET_KEY и AWS_SECURITY_TOKEN устарела и будет удалена в релизе после 2024-12-01.

состояние

строка / обязательно

Создание или удаление группы IAM.

Варианты:

  • "present"
  • "absent"

пользователи

список / элементы=строка

Список существующих пользователей для добавления в качестве членов группы.

По умолчанию: []

validate_certs

булево

При установке в false, сертификаты SSL не будут проверяться для связи с API AWS.

Установка validate_certs=false категорически не рекомендуется, как альтернатива, установите aws_ca_bundle вместо этого.

Варианты:

  • false
  • true ← (по умолчанию)

Примечания

Примечание

  • Внимание: Для модулей переменные среды и конфигурационные файлы считываются из контекста Ansible «хост», а не из контекста «контроллер». В связи с этим файлы могут потребоваться явно скопировать на «хост». Для плагинов поиска и соединения переменные среды и конфигурационные файлы считываются из контекста Ansible «контроллер», а не из контекста «хост».
  • AWS SDK (boto3), используемый Ansible, также может считывать значения по умолчанию для учетных данных и других параметров, таких как регион, из своих конфигурационных файлов в контексте Ansible «хост» (обычно ~/.aws/credentials). Дополнительную информацию см. по https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html.

Примеры

# Note: These examples do not set authentication details, see the AWS Guide for details.

- name: Create a group
  amazon.aws.iam_group:
    name: testgroup1
    state: present

- name: Create a group and attach a managed policy using its ARN
  amazon.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
  amazon.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
  amazon.aws.iam_group:
    name: testgroup1
    state: present
    purge_policies: true

- name: Remove all group members from an existing group
  amazon.aws.iam_group:
    name: testgroup1
    managed_policies:
      - arn:aws:iam::aws:policy/AmazonSNSFullAccess
    purge_users: true
    state: present

- name: Delete the group
  amazon.aws.iam_group:
    name: testgroup1
    state: absent

Значения возврата

Общие значения возврата документированы здесь, следующие — поля, уникальные для данного модуля:

Ключ

Описание

iam_group

сложный

Словарь, содержащий всю информацию о группе, включая состав группы.

Возвращается: успешно

attached_policies

сложный

добавлен в amazon.aws 7.1.0

Список, содержащий основную информацию о политиках, прикреплённых к группе.

Возвращается: успешно

policy_arn

строка

Идентификатор ресурса Amazon (ARN), определяющий управляемую политику.

Возвращается: успешно

Пример: "arn:aws:iam::123456789012:policy/test_policy"

policy_name

строка

Наименование политики для удобства идентификации.

Возвращается: успешно

Пример: "test_policy"

group

сложный

Словарь, содержащий всю информацию о группе.

Возвращается: успешно

arn

строка

Идентификатор ресурса Amazon (ARN), определяющий группу.

Возвращается: успешно

Пример: "arn:aws:iam::1234567890:group/testgroup1"

create_date

строка

Дата и время создания группы в формате ISO 8601.

Возвращается: успешно

Пример: "2017-02-08T04:36:28+00:00"

group_id

строка

Уникальная строка, идентифицирующая группу.

Возвращается: успешно

Пример: "AGPA12345EXAMPLE54321"

group_name

строка

Наименование группы для удобства идентификации.

Возвращается: успешно

Пример: "testgroup1"

path

строка

Путь к группе.

Возвращается: успешно

Пример: "/"

users

сложный

Список всех членов группы.

Возвращается: успешно

arn

строка

Идентификатор ресурса Amazon (ARN), определяющий пользователя.

Возвращается: успешно

Пример: "arn:aws:iam::1234567890:user/test_user1"
... ...

Авторы

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

Ссылки на коллекции

  • Система отслеживания задач
  • Репозиторий (источники)
  • Связь

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/amazon/aws/iam_group_module.html

Spec-Zone.ru

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