amazon.aws.aws_account_attribute lookup – Поиск атрибутов учетной записи AWS
Примечание
Этот плагин поиска входит в коллекцию amazon.aws (версия 11.3.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install amazon.aws. Для работы с этим плагином поиска требуются дополнительные компоненты. Подробнее см. в разделе Требования.
Чтобы использовать его в плейбуке, укажите: amazon.aws.aws_account_attribute.
Краткое описание
- Описывает атрибуты вашей учетной записи AWS. Можно указать один из перечисленных атрибутов или не указывать его, чтобы просмотреть все атрибуты.
Требования
Следующие требования должны быть выполнены на локальном узле контроллера, на котором выполняется этот поиск.
- python >= 3.6
- boto3 >= 1.35.0
- botocore >= 1.35.0
Параметры ключевых слов
Здесь описаны параметры ключевых слов для поиска. В следующих примерах это значения key1=value1, key2=value2 и так далее: lookup('amazon.aws.aws_account_attribute', key1=value1, key2=value2, ...) и query('amazon.aws.aws_account_attribute', key1=value1, key2=value2, ...)
Параметр | Комментарии |
|---|---|
access_key псевдонимы: 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 и profile нельзя использовать одновременно. Псевдоним aws_access_key_id добавлен в выпуске 5.1.0 для соответствия SDK AWS botocore. Конфигурация:
|
attribute string | Атрибут, значение которого нужно получить. Допустимые значения:
|
endpoint_url псевдонимы: aws_endpoint_url string | URL для подключения вместо конечных точек AWS по умолчанию. Его можно использовать для подключения к другим сервисам, совместимым с AWS, однако коллекции amazon.aws и community.aws тестируются только с AWS. Конфигурация:
|
profile псевдонимы: aws_profile string | Именованный профиль AWS для аутентификации. Дополнительные сведения об именованных профилях см. в документации AWS: https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html. Параметр profile нельзя использовать одновременно с параметрами aws_access_key, aws_secret_key и session_token. Конфигурация:
|
region псевдонимы: aws_region string | Регион AWS, который следует использовать. Дополнительные сведения см. в документации Amazon AWS: http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region. Конфигурация:
|
secret_key псевдонимы: 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. Параметры secret_key и profile нельзя использовать одновременно. Псевдоним aws_secret_access_key добавлен в выпуске 5.1.0 для соответствия SDK AWS botocore. Конфигурация:
|
session_token псевдонимы: 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. Параметры session_token и profile нельзя использовать одновременно. Конфигурация:
|
Примечание
Перечисленные выше записи конфигурации для каждого типа записей (переменная Ansible, переменная среды и т. д.) расположены в порядке приоритета от низкого к высокому. Например, переменная, находящаяся ниже в списке, переопределяет переменную, находящуюся выше. Типы записей также упорядочены по приоритету от низкого к высокому. Например, запись в ansible.cfg (расположенная выше в списке) переопределяется переменной Ansible (расположенной ниже в списке).
Примечания
Примечание
- Внимание: Для модулей переменные среды и файлы конфигурации считываются из контекста «узла» Ansible, а не из контекста «контроллера». Поэтому файлы может потребоваться явно скопировать на «узел». Для плагинов поиска и подключения переменные среды и файлы конфигурации считываются из контекста «контроллера» Ansible, а не из контекста «узла».
- Используемый Ansible SDK AWS (boto3) также может считывать значения по умолчанию для учетных данных и других настроек, например региона, из файлов конфигурации в контексте «узла» Ansible (обычно
~/.aws/credentials). Дополнительные сведения см. на странице https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html.
Примеры
vars:
has_ec2_classic: "{{ lookup('aws_account_attribute', attribute='has-ec2-classic') }}"
# true | false
default_vpc_id: "{{ lookup('aws_account_attribute', attribute='default-vpc') }}"
# vpc-xxxxxxxx | none
account_details: "{{ lookup('aws_account_attribute', wantlist='true') }}"
# {'default-vpc': ['vpc-xxxxxxxx'], 'max-elastic-ips': ['5'], 'max-instances': ['20'],
# 'supported-platforms': ['VPC', 'EC2'], 'vpc-max-elastic-ips': ['5'], 'vpc-max-security-groups-per-interface': ['5']}
Возвращаемое значение
Ключ | Описание |
|---|---|
Возвращаемое значение string | Возвращает логическое значение, если Возвращается: при успешном выполнении |
Ссылки на коллекцию
© 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/aws_account_attribute_lookup.html
