Модуль amazon.aws.iam_role_info — Сбор информации об IAM-ролях
Примечание
Этот модуль входит в коллекцию amazon.aws (версия 8.2.1).
Возможно, эта коллекция уже установлена, если вы используете пакет 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.26.0
- botocore >= 1.29.0
Параметры
Параметр | Комментарии |
|---|---|
access_key псевдонимы: aws_access_key_id, aws_access_key, ec2_access_key строка | ID ключа доступа AWS. Дополнительную информацию о маркерах доступа можно найти в документации AWS https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также можно использовать переменные среды Параметры aws_access_key и profile взаимоисключающие. Псевдоним aws_access_key_id был добавлен в релизе 5.1.0 для согласованности с SDK AWS botocore. Псевдоним ec2_access_key устарел и будет удален в релизе после 2024-12-01. Поддержка переменной среды |
aws_ca_bundle путь | Расположение файла CA-сертификатов для проверки SSL-сертификатов. Также можно использовать переменную среды |
aws_config словарь | Словарь для модификации конфигурации botocore. Параметры можно найти в документации AWS https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. |
debug_botocore_endpoint_logs булево | Использовать логгер Также можно использовать переменную среды Варианты:
|
endpoint_url псевдонимы: ec2_url, aws_endpoint_url, s3_url строка | URL для подключения вместо стандартных конечных точек AWS. Хотя это можно использовать для подключения к другим совместимым с AWS службам, коллекции amazon.aws и community.aws протестированы только для AWS. Также можно использовать переменные среды Псевдонимы ec2_url и s3_url устарели и будут удалены в релизе после 2024-12-01. Поддержка переменной среды |
name псевдонимы: role_name строка | Имя роли для поиска. Взаимоисключающее с |
path_prefix псевдонимы: path, prefix строка | |
profile псевдонимы: aws_profile строка | Имя профиля AWS для аутентификации. Дополнительную информацию о именованных профилях можно найти в документации AWS https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html. Также можно использовать переменную среды Параметр profile взаимоисключающий с параметрами aws_access_key, aws_secret_key и security_token. |
region псевдонимы: aws_region, ec2_region строка | AWS регион для использования. Для глобальных сервисов, таких как IAM, Route53 и CloudFront, параметр region игнорируется. Также можно использовать переменные среды Дополнительную информацию можно найти в документации Amazon AWS http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region. Псевдоним Поддержка переменной среды |
secret_key псевдонимы: aws_secret_access_key, aws_secret_key, ec2_secret_key строка | Секретный ключ доступа AWS. Дополнительную информацию о маркерах доступа можно найти в документации AWS https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также можно использовать переменные среды Параметры secret_key и profile взаимоисключающие. Псевдоним aws_secret_access_key был добавлен в релизе 5.1.0 для согласованности с SDK AWS botocore. Псевдоним ec2_secret_key устарел и будет удален в релизе после 2024-12-01. Поддержка переменной среды |
session_token aliases: aws_session_token, security_token, aws_security_token, access_token строка | Токен сессии AWS STS для использования с временными учетными данными. См. документацию AWS для получения дополнительной информации об access token https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также могут использоваться переменные среды Параметры security_token и profile взаимоисключающие. Псевдонимы aws_session_token и session_token были добавлены в релизе 3.2.0, а параметр был переименован из security_token в session_token в релизе 6.0.0. Псевдонимы security_token, aws_security_token и access_token устарели и будут удалены в релизе после 01.12.2024. Поддержка переменных среды |
validate_certs булево | При установке в значение Установка validate_certs=false категорически не рекомендуется. В качестве альтернативы, рассмотрите установку aws_ca_bundle. Варианты:
|
Примечания
Примечание
- Внимание: Для модулей переменные окружения и конфигурационные файлы читаются из контекста Ansible 'хост', а не из контекста 'контроллер'. Следовательно, файлы могут потребоваться скопировать на 'хост'. Для плагинов поиска и подключения переменные окружения и конфигурационные файлы читаются из контекста Ansible 'контроллер', а не из контекста 'хост'.
- AWS SDK (boto3), который используется Ansible, также может считывать значения по умолчанию для учетных данных и других настроек, таких как регион, из его конфигурационных файлов в контексте 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 для роли IAM. Возвращается: всегда Пример: |
|
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. Возвращается: всегда |
|
create_date string |
Дата создания роли IAM. Возвращается: всегда Пример: |
|
inline_policies list / elements=string |
Список имен встроенных политик. Возвращается: всегда Пример: |
|
instance_profiles complex |
Список присоединенных профилей экземпляров. Возвращается: всегда |
|
arn string |
Универсальное имя ресурса Amazon для профиля экземпляра. Возвращается: всегда Пример: |
|
create_date string |
Дата создания профиля экземпляра. Возвращается: всегда Пример: |
|
instance_profile_id string |
Идентификатор Amazon для профиля экземпляра. Возвращается: всегда Пример: |
|
instance_profile_name string |
Имя профиля экземпляра. Возвращается: всегда Пример: |
|
path string |
Путь профиля экземпляра. Возвращается: всегда Пример: |
|
roles list / elements=string |
Список ролей, связанных с этим профилем экземпляра. Возвращается: всегда Пример: |
|
managed_policies complex |
Список присоединенных управляемых политик. Возвращается: всегда |
|
policy_arn string |
Универсальное имя ресурса Amazon для политики. Возвращается: всегда Пример: |
|
policy_name string |
Имя управляемой политики. Возвращается: всегда Пример: |
|
path string |
Путь роли. Возвращается: всегда Пример: |
|
role_id string |
Идентификатор Amazon для роли. Возвращается: всегда Пример: |
|
role_name string |
Имя роли. Возвращается: всегда Пример: |
|
tags dictionary |
Теги роли. Возвращается: всегда Пример: |
Ссылки на сборку
© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/amazon/aws/iam_role_info_module.html