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

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет 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.35.0
botocore >= 1.35.0

Параметры

Параметр	Комментарии
access_key псевдонимы: aws_access_key_id, aws_access_key string	Идентификатор ключа доступа 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` в порядке убывания приоритета. Параметры aws_access_key и profile являются взаимоисключающими. Псевдоним aws_access_key_id добавлен в выпуске 5.1.0 для единообразия с AWS botocore SDK.
aws_ca_bundle path	Путь к пакету сертификатов CA, используемому для проверки SSL-сертификатов. Также можно использовать переменную среды `AWS_CA_BUNDLE`.
aws_config dictionary	Словарь для изменения конфигурации botocore. Параметры описаны в документации AWS: https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.
debug_botocore_endpoint_logs boolean	Использовать журналирование `botocore.endpoint` для сбора уникальных (а не всех) вызовов API `"resource:action"`, выполненных во время задачи, и вывода их набора в ключ resource_actions результатов задачи. Используйте callback `aws_resource_action`, чтобы вывести полный список вызовов, выполненных в ходе плейбука. Также можно использовать переменную среды `ANSIBLE_DEBUG_BOTOCORE_LOGS`. Варианты: `false` ← (по умолчанию) `true`
endpoint_url псевдонимы: aws_endpoint_url string	URL для подключения вместо конечных точек AWS по умолчанию. Хотя этот параметр можно использовать для подключения к другим совместимым с AWS службам, коллекции amazon.aws и community.aws тестируются только с AWS. Также можно использовать переменную среды `AWS_URL`.
managed_policies псевдоним: managed_policy list / элементы=string	Список ARN управляемых политик или их понятных имен для прикрепления к роли. Если они известны, рекомендуется указывать ARN вместо понятных имен, чтобы избежать дополнительных запросов. Чтобы встроить встроенную политику, используйте amazon.aws.iam_policy. По умолчанию: `[]`
name псевдоним: group_name string / обязательный	Имя группы. Примечание: имена групп уникальны в пределах учетной записи. Пути (`path`) не влияют на требования уникальности `name`. Например, в одной учетной записи нельзя иметь одновременно `/Path1/MyGroup` и `/Path2/MyGroup`. Псевдоним `group_name` добавлен в выпуске 7.2.0.
path псевдонимы: prefix, path_prefix string добавлено в amazon.aws 7.1.0	Путь группы. Дополнительные сведения о путях IAM см. в документации по идентификаторам AWS IAM: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html.
profile псевдоним: aws_profile string	Именованный профиль AWS для аутентификации. Дополнительные сведения об именованных профилях см. в документации AWS: https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html. Также можно использовать переменную среды `AWS_PROFILE`. Параметр profile является взаимоисключающим с параметрами aws_access_key, aws_secret_key и session_token.
purge_policies псевдонимы: purge_policy, purge_managed_policies boolean	Если `purge_policies=true`, все управляемые политики, не указанные в `managed_policies`, будут отсоединены. Варианты: `false` ← (по умолчанию) `true`
purge_users boolean	Если `purge_users=true`, пользователи, не включенные в users, будут отсоединены. Варианты: `false` ← (по умолчанию) `true`
region псевдоним: aws_region string	Регион AWS. Для глобальных служб, таких как IAM, Route53 и CloudFront, параметр region игнорируется. Также можно использовать переменную среды `AWS_REGION`. Дополнительные сведения см. в документации Amazon AWS: http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region.
secret_key псевдонимы: aws_secret_access_key, aws_secret_key string	Секретный ключ доступа 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` в порядке убывания приоритета. Параметры secret_key и profile являются взаимоисключающими. Псевдоним aws_secret_access_key добавлен в выпуске 5.1.0 для единообразия с AWS botocore SDK.
session_token псевдоним: aws_session_token string	Токен сеанса 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`. Параметры session_token и profile являются взаимоисключающими.
state string / обязательный	Создать или удалить группу IAM. Варианты: `"present"` `"absent"`
users list / элементы=string	Список существующих пользователей, которых нужно добавить в группу. По умолчанию: `[]`
validate_certs boolean	Если задано значение `false`, SSL-сертификаты при обмене данными с API AWS проверяться не будут. Настоятельно не рекомендуется задавать validate_certs=false; вместо этого рассмотрите возможность указать aws_ca_bundle. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

Внимание: Для модулей переменные среды и файлы конфигурации считываются из контекста «хоста» Ansible, а не из контекста «контроллера». Поэтому файлы может потребоваться явно скопировать на «хост». Для плагинов поиска и подключений переменные среды и файлы конфигурации считываются из контекста «контроллера» Ansible, а не из контекста «хоста».
Используемый Ansible AWS SDK (boto3) также может считывать значения учетных данных и других параметров по умолчанию, например региона, из файлов конфигурации в контексте «хоста» 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 complex	Словарь со всеми сведениями о группе, включая членство в группе. Возвращается: при успехе
attached_policies complex добавлено в amazon.aws 7.1.0	Список с основной информацией об управляемых политиках, прикрепленных к группе. Возвращается: при успехе
policy_arn string	Имя ресурса Amazon (ARN), указывающее управляемую политику. Возвращается: при успехе Пример: `"arn:aws:iam::123456789012:policy/test_policy"`
policy_name string	Понятное имя, идентифицирующее политику. Возвращается: при успехе Пример: `"test_policy"`
group complex	Словарь со всеми сведениями о группе. Возвращается: при успехе
arn string	Имя ресурса Amazon (ARN), указывающее группу. Возвращается: при успехе Пример: `"arn:aws:iam::1234567890:group/testgroup1"`
create_date string	Дата и время создания группы в формате даты и времени ISO 8601. Возвращается: при успехе Пример: `"2017-02-08T04:36:28+00:00"`
group_id string	Стабильная и уникальная строка, идентифицирующая группу. Возвращается: при успехе Пример: `"AGPA12345EXAMPLE54321"`
group_name string	Понятное имя, идентифицирующее группу. Возвращается: при успехе Пример: `"testgroup1"`
path string	Путь к группе. Возвращается: при успехе Пример: `"/"`
users complex	Список всех участников группы. Возвращается: при успехе
arn string	Имя ресурса Amazon (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	Стабильная и уникальная строка, идентифицирующая пользователя. Возвращается: при успехе Пример: `"AIDA12345EXAMPLE54321"`
user_name string	Понятное имя, идентифицирующее пользователя. Возвращается: при успехе Пример: `"testgroup1"`

Авторы

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

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

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