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: of 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 путь | Расположение файла с корневыми сертификатами для проверки SSL-сертификатов. Используется только для модулей, основанных на boto3. Примечание: Файл с сертификатами читается со стороны модуля и может потребоваться скопировать его с контроллера, если он не используется локально. | |
| aws_config словарь | Словарь для изменения конфигурации botocore. Параметры можно найти по адресу https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. Для модулей boto используется только ключ 'user_agent'. См. 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 строка | 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 сложный | всегда | Список ролей IAM | ||
| arn строка | всегда | Идентификатор ресурса Amazon для роли IAM. Пример: arn:aws:iam::123456789012:role/AnsibleTestRole | ||
| assume_role_policy_document строка | всегда | Документ политики, описывающий, кто может принять роль. | ||
| create_date строка | всегда | Дата создания роли IAM. Пример: 2017-10-23T00:05:08+00:00 | ||
| inline_policies список / элементы=строка | всегда | Список имён встроенных политик. | ||
| instance_profiles сложный | всегда | Список прикреплённых профилей экземпляров. | ||
| arn строка | всегда | Идентификатор ресурса Amazon для профиля экземпляра. Пример: arn:aws:iam::123456789012:instance-profile/AnsibleTestEC2Policy | ||
| create_date строка | всегда | Дата создания профиля экземпляра. Пример: 2017-10-23T00:05:08+00:00 | ||
| instance_profile_id строка | всегда | Идентификатор Amazon для профиля экземпляра. Пример: AROAII7ABCD123456EFGH | ||
| instance_profile_name строка | всегда | Имя профиля экземпляра. Пример: AnsibleTestEC2Policy | ||
| path строка | всегда | Путь профиля экземпляра. Пример: / | ||
| roles список / элементы=строка | всегда | Список ролей, связанных с этим профилем экземпляра. | ||
| managed_policies сложный | всегда | Список прикреплённых управляемых политик. | ||
| policy_arn строка | всегда | Идентификатор ресурса Amazon для политики. Пример: arn:aws:iam::123456789012:policy/AnsibleTestEC2Policy | ||
| policy_name строка | всегда | Имя управляемой политики. Пример: AnsibleTestEC2Policy | ||
| path строка | всегда | Путь роли. Пример: / | ||
| role_id строка | всегда | Идентификатор Amazon для роли. Пример: AROAII7ABCD123456EFGH | ||
| role_name строка | всегда | Имя роли. Пример: AnsibleTestRole | ||
| tags словарь | всегда | Теги роли. Пример: {"Env": "Prod"} | ||
Авторы
- Will Thames (@willthames)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/aws/iam_role_info_module.html