iam_role_info – Сбор информации о ролях IAM
Новое в версии 2.5.
Описание
- Сбор информации о ролях IAM
- Этот модуль назывался
iam_role_factsдо Ansible 2.9. Использование не изменилось.
Псевдонимы: iam_role_facts
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- boto
- boto3
- 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 | |
| debug_botocore_endpoint_logs логический добавлено в 2.8 |
| Использование логгера botocore.endpoint для парсинга уникальных (а не общих) API-вызовов «resource:action», выполненных во время задачи, выводящих набор в ключ resource_actions в результатах задачи. Используйте обратный вызов aws_resource_action для вывода полного списка, созданного во время выполнения playbook. Также может использоваться переменная среды ANSIBLE_DEBUG_BOTOCORE_LOGS. |
| ec2_url строка | URL для подключения к облаку EC2 или Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где регион обязателен. Должен быть указан для всех других модулей, если регион не используется. Если не задан, используется значение переменной среды EC2_URL, если она существует. | |
| name - | Имя роли, которую необходимо найти. Взаимоисключающее с prefix.
Псевдонимы: role_name | |
| path_prefix - | Префикс пути к роли для ограничения поиска роли IAM. Взаимоисключающее с name.
| |
| profile строка | Использование профиля boto. Работает только с boto >= 2.24.0. | |
| 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 security token. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. Псевдонимы: access_token | |
| validate_certs логический |
| При значении «нет», сертификаты 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
Примеры
# find all existing IAM roles
- iam_role_info:
register: result
# describe a single role
- iam_role_info:
name: MyIAMRole
# describe all roles matching a path prefix
- iam_role_info:
path_prefix: /application/path
Значения возврата
Общие значения возврата описаны в здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание | ||
|---|---|---|---|---|
| iam_roles сложный | всегда | Список ролей IAM | ||
| arn строка | всегда | Идентификатор Amazon (ARN) роли 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) профиля экземпляра Пример: 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) политики Пример: arn:aws:iam::123456789012:policy/AnsibleTestEC2Policy | ||
| policy_name строка | всегда | Имя управляемой политики Пример: AnsibleTestEC2Policy | ||
| path строка | всегда | Путь роли Пример: / | ||
| role_id строка | всегда | Идентификатор Amazon роли Пример: AROAII7ABCD123456EFGH | ||
| role_name строка | всегда | Имя роли Пример: AnsibleTestRole | ||
Статус
- Данный модуль не гарантирует обратной совместимости. [превью]
- Данный модуль поддерживается сообществом Ansible. [сообщество]
Авторы
- 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.9/modules/iam_role_info_module.html