Spec-Zone.ru › Ansible 2.10

community.aws.iam_role_facts – Сбор информации о ролях IAM

Примечание

Этот плагин входит в состав коллекции community.aws (версия 1.3.0).

Для его установки используйте: ansible-galaxy collection install community.aws.

Чтобы использовать его в книге задач, укажите: community.aws.iam_role_facts.

Новое в версии 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 читается на стороне модуля и может потребоваться явно скопировать его с контроллера, если он не запускается локально.
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 для анализа уникальных (а не общих) вызовов 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_facts_module.html

Spec-Zone.ru

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