Модуль amazon.aws.aws_caller_info – Получение информации о пользователе и аккаунте, используемых для выполнения вызовов AWS
Примечание
Этот модуль входит в коллекцию amazon.aws (версия 8.2.1).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить её установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install amazon.aws. Для использования этого модуля необходимы дополнительные требования, см. Требования для получения подробностей.
Для использования в книге задач укажите: amazon.aws.aws_caller_info.
Новое в amazon.aws 1.0.0
Обзор
- Этот модуль возвращает информацию об аккаунте и пользователе/роли, из которых происходят токены доступа AWS.
- Основное применение — получение идентификатора аккаунта для использования в шаблонах ARNs и подобных задачах, чтобы не указывать эту информацию в инвентаре.
Требования
Ниже перечислены требования, необходимые на хосте, который выполняет этот модуль.
- python >= 3.6
- boto3 >= 1.26.0
- botocore >= 1.29.0
Параметры
Параметр | Комментарии |
|---|---|
access_key псевдонимы: aws_access_key_id, aws_access_key, ec2_access_key строка | Идентификатор ключа доступа 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 путь | Расположение файла с корневыми сертификатами для проверки 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. Поддержка переменной среды |
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 псевдонимы: aws_session_token, security_token, aws_security_token, access_token строка | Токен сессии AWS STS для использования с временными учетными данными. Дополнительную информацию об маркерах доступа см. в документации AWS 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 устарели и будут удалены в релизе после 2024-12-01. Поддержка переменных среды |
validate_certs логический тип | При установке в Установка validate_certs=false решительно не рекомендуется. В качестве альтернативы, рассмотрите установку aws_ca_bundle вместо этого. Варианты:
|
Примечания
Примечание
- Предупреждение: Для модулей переменные среды и конфигурационные файлы читаются из контекста Ansible ‘host’, а не ‘controller’. Поэтому файлы может потребоваться скопировать в ‘host’. Для плагинов lookup и connection переменные среды и конфигурационные файлы читаются из контекста Ansible ‘controller’, а не ‘host’.
- AWS SDK (boto3), используемый Ansible, также может читать значения по умолчанию для учетных данных и других настроек, таких как регион, из своих конфигурационных файлов в контексте Ansible ‘host’ (обычно
~/.aws/credentials). Дополнительную информацию см. в https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html.
Примеры
# Note: These examples do not set authentication details, see the AWS Guide for details. - name: Get the current caller identity information amazon.aws.aws_caller_info: register: caller_info
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
Ключ | Описание |
|---|---|
account строка | Идентификатор учетной записи, с которой связаны учетные данные доступа. Возвращается: success Пример: |
account_alias строка | Псевдоним учетной записи, с которым связаны учетные данные доступа. Возвращается: при наличии у вызывающей стороны разрешения iam:ListAccountAliases Пример: |
arn строка | ARN, определяющий пользователя, с которым связаны учетные данные. Возвращается: success Пример: |
user_id строка | Идентификатор пользователя, с которым связаны учетные данные доступа. Обратите внимание, что в случае ролей или федеративных идентификаторов это значение может не соответствовать ничему, что вы можете найти. Возвращается: success Пример: |
Ссылки на сборку
© 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/aws_caller_info_module.html
