Spec-Zone.ru › Ansible

Модуль amazon.aws.iam_role_info — сбор информации о ролях IAM

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните команду ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install amazon.aws. Для использования этого модуля требуются дополнительные компоненты. Подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: amazon.aws.iam_role_info.

Добавлено в community.aws 1.0.0

  • Краткое описание
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Краткое описание

  • Собирает информацию о ролях IAM.

Требования

Следующие компоненты должны быть установлены на узле, на котором выполняется этот модуль.

  • python >= 3.6
  • boto3 >= 1.35.0
  • botocore >= 1.35.0

Параметры

Параметр

Комментарии

access_key

aliases: 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

aliases: aws_endpoint_url

string

URL для подключения вместо конечных точек AWS по умолчанию. Хотя этот параметр можно использовать для подключения к другим совместимым с AWS сервисам, коллекции amazon.aws и community.aws тестируются только с AWS.

Также можно использовать переменную окружения AWS_URL.

name

aliases: role_name

string

Имя роли для поиска.

Взаимоисключающий параметр с path_prefix.

path_prefix

aliases: path, prefix

string

Префикс для ограничения поиска ролей IAM.

Взаимоисключающий параметр с name.

path и prefix добавлены в качестве псевдонимов в выпуске 7.2.0.

В выпуске после 2026-05-01 пути должны начинаться и заканчиваться символом /. До этого пути будут автоматически дополняться символом / при необходимости, чтобы начинаться и заканчиваться символом /.

profile

aliases: 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.

region

aliases: 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

aliases: 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

aliases: 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 являются взаимоисключающими.

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.

Примеры

- name: find all existing IAM roles
  amazon.aws.iam_role_info:
  register: result

- name: describe a single role
  amazon.aws.iam_role_info:
    name: MyIAMRole

- name: describe all roles matching a path prefix
  amazon.aws.iam_role_info:
    path_prefix: /application/path/

Возвращаемые значения

Общие возвращаемые значения описаны здесь. Ниже перечислены поля, уникальные для этого модуля:

Ключ

Описание

iam_roles

complex

Список ролей IAM.

Возвращается: всегда

arn

string

Имя ресурса Amazon (ARN) роли IAM.

Возвращается: всегда

Пример: "arn:aws:iam::123456789012:role/AnsibleTestRole"

assume_role_policy_document

dictionary

Политика, предоставляющая субъекту разрешение принимать роль.

Примечание: регистр ключей в этом словаре больше не преобразуется из CamelCase в snake_case. Это поведение изменилось в выпуске 8.0.0.

Возвращается: всегда

assume_role_policy_document_raw

dictionary

добавлено в amazon.aws 5.3.0

Примечание: это возвращаемое значение объявлено устаревшим и будет удалено в выпуске после 2026-05-01. iam_roles.assume_role_policy_document и iam_roles.assume_role_policy_document_raw теперь используют один и тот же формат.

Возвращается: всегда

create_date

string

Дата создания роли IAM.

Возвращается: всегда

Пример: "2017-10-23T00:05:08+00:00"

inline_policies

list / elements=string

Список имен встроенных политик.

Возвращается: всегда

Пример: []

instance_profiles

complex

Список подключенных профилей экземпляров.

Возвращается: всегда

arn

string

Имя ресурса Amazon (ARN) профиля экземпляра.

Возвращается: всегда

Пример: "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) политики.

Возвращается: всегда

Пример: "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–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/amazon/aws/iam_role_info_module.html

Spec-Zone.ru

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