community.aws.iam_role_info – Сбор информации о ролях IAM
Примечание
Этот плагин входит в коллекцию community.aws (версия 1.3.0).
Для его установки используйте: ansible-galaxy collection install community.aws.
Для использования в книге задач, укажите: community.aws.iam_role_info.
Новое в версии 1.0.0: из community.aws
Обзор
- Сбор информации о ролях IAM.
- Этот модуль назывался
iam_role_factsдо Ansible 2.9. Использование не изменилось.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- boto
- boto3
- python >= 2.6
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| aws_access_key строка | Ключ доступа AWS. Если не задан, используется значение переменной окружения AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY. Если задан параметр profile, этот параметр игнорируется. Передача параметров aws_access_key и profile одновременно устарела и параметры будут сделаны взаимоисключающими после 2022-06-01. псевдонимы: ec2_access_key, access_key | |
| aws_ca_bundle путь | Расположение файла сертификата CA для проверки SSL-сертификатов. Используется только для модулей на основе boto3. Примечание: Файл CA Bundle читается со стороны модуля и может потребоваться явно скопировать его с контроллера, если он не запускается локально. | |
| aws_config словарь | Словарь для изменения конфигурации botocore. Параметры можно найти по адресу https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. Только ключ 'user_agent' используется для модулей boto. См. http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto для получения дополнительной информации о конфигурации boto. | |
| aws_secret_key строка | Секретный ключ AWS. Если не задан, используется значение переменной окружения AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY. Если задан параметр profile, этот параметр игнорируется. Передача параметров aws_secret_key и profile одновременно устарела и параметры будут сделаны взаимоисключающими после 2022-06-01. псевдонимы: ec2_secret_key, secret_key | |
| debug_botocore_endpoint_logs булево |
| Используйте логгер botocore.endpoint для анализа уникальных (а не общих) API-вызовов «ресурс:действие», выполняемых во время задачи, выводив набор в ключ resource_actions в результатах задачи. Используйте обратный вызов aws_resource_action для вывода в общий список, созданный во время выполнения книги задач. Также может быть использована переменная среды ANSIBLE_DEBUG_BOTOCORE_LOGS. |
| ec2_url строка | Адрес для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль будет использовать адреса EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех других модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если таковое имеется. псевдонимы: aws_endpoint_url, endpoint_url | |
| name строка | Имя роли для поиска. Взаимоисключающий с path_prefix. псевдонимы: role_name | |
| path_prefix строка | Префикс роли для ограничения поиска ролей IAM. Взаимоисключающий с name. | |
| profile строка | Использование профиля boto. Работает только с boto >= 2.24.0. Использование profile переопределяет aws_access_key, aws_secret_key и security_token, и поддержка их передачи одновременно с profile устарела. aws_access_key, aws_secret_key и security_token будут сделаны взаимоисключающими с profile после 2022-06-01. псевдонимы: aws_profile | |
| 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. Если задан параметр profile, этот параметр игнорируется. Передача параметров security_token и profile одновременно устарела и параметры будут сделаны взаимоисключающими после 2022-06-01. псевдонимы: aws_security_token, access_token | |
| validate_certs булево |
| Если установлено «нет», SSL-сертификаты не будут проверяться для версий boto >= 2.6.0. |
Примечания
Примечание
- Если параметры не заданы внутри модуля, можно использовать следующие переменные среды в порядке убывания приоритета
AWS_URLилиEC2_URL,AWS_PROFILEилиAWS_DEFAULT_PROFILE,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,AWS_CA_BUNDLE - Ansible использует конфигурационный файл boto (обычно ~/.boto), если учетные данные не предоставлены. См. https://boto.readthedocs.io/en/latest/boto_config_tut.html
-
AWS_REGIONилиEC2_REGIONобычно используются для указания региона AWS, когда это необходимо, но это также можно настроить в файле конфигурации boto
Примеры
- name: find all existing IAM roles
community.aws.iam_role_info:
register: result
- name: describe a single role
community.aws.iam_role_info:
name: MyIAMRole
- name: describe all roles matching a path prefix
community.aws.iam_role_info:
path_prefix: /application/path
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Краткое описание полей | Возвращаемое значение | Описание | ||
|---|---|---|---|---|
| iam_roles complex | всегда | Список ролей IAM | ||
| arn string | всегда | Идентификатор ресурса Amazon для роли IAM. Пример: arn:aws:iam::123456789012:role/AnsibleTestRole | ||
| assume_role_policy_document string | всегда | Документ политики, описывающий, кто может принять роль. | ||
| create_date string | всегда | Дата создания роли IAM. Пример: 2017-10-23T00:05:08+00:00 | ||
| inline_policies list / elements=string | всегда | Список имён встроенных политик. | ||
| instance_profiles complex | всегда | Список присоединённых профилей экземпляров. | ||
| arn string | всегда | Идентификатор ресурса Amazon для профиля экземпляра. Пример: arn:aws:iam::123456789012:instance-profile/AnsibleTestEC2Policy | ||
| create_date string | всегда | Дата создания профиля экземпляра. Пример: 2017-10-23T00:05:08+00:00 | ||
| instance_profile_id string | всегда | Идентификатор Amazon для профиля экземпляра. Пример: AROAII7ABCD123456EFGH | ||
| instance_profile_name string | всегда | Имя профиля экземпляра. Пример: AnsibleTestEC2Policy | ||
| path string | всегда | Путь профиля экземпляра. Пример: / | ||
| roles list / elements=string | всегда | Список ролей, связанных с этим профилем экземпляра. | ||
| managed_policies complex | всегда | Список присоединённых управляемых политик. | ||
| policy_arn string | всегда | Идентификатор ресурса Amazon для политики. Пример: arn:aws:iam::123456789012:policy/AnsibleTestEC2Policy | ||
| policy_name string | всегда | Имя управляемой политики. Пример: AnsibleTestEC2Policy | ||
| path string | всегда | Путь роли. Пример: / | ||
| role_id string | всегда | Идентификатор Amazon для роли. Пример: AROAII7ABCD123456EFGH | ||
| role_name string | всегда | Имя роли. Пример: AnsibleTestRole | ||
| tags dictionary | всегда | Теги роли. Пример: {"Env": "Prod"} | ||
Авторы
- Will Thames (@willthames)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/aws/iam_role_info_module.html