community.aws.aws_region_info – Сбор информации о регионах AWS.

Примечание

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

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

Чтобы использовать его в плейбуке, укажите: community.aws.aws_region_info.

В версии 1.0.0: из community.aws

Обзор
Требования
Параметры
Примечания
Примеры
Значения возврата

Обзор

Сбор информации о регионах AWS.
Этот модуль назывался aws_region_facts до Ansible 2.9. Способ использования не изменился.

Требования

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

boto
boto3
botocore
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 Bundle для проверки SSL-сертификатов. Используется только для модулей, основанных на boto3. Примечание: CA Bundle считывается со стороны модуля и может потребоваться явное копирование с контроллера, если он не используется локально.
aws_config словарь		Словарь для изменения конфигурации botocore. Параметры можно найти по адресу https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. Для модулей boto используется только ключ 'user_agent'. Дополнительные конфигурации для boto см. по адресу http://boto.cloudhackers.com/en/latest/boto_config_tut.html#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.endpoint для анализа уникальных (а не суммарных) API-вызовов "ресурс:действие" во время выполнения задачи, выводимых в ключ task results с именем resource_actions. Используйте обратный вызов aws_resource_action для вывода полного списка, созданного во время плейбука. Также можно использовать переменную окружения ANSIBLE_DEBUG_BOTOCORE_LOGS.
ec2_url строка		URL для подключения к EC2 или Eucalyptus cloud (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех остальных модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если она есть. псевдонимы: aws_endpoint_url, endpoint_url
filters словарь	Значение по умолчанию: {}	Словарь фильтров для применения. Каждый элемент словаря содержит ключ фильтра и значение фильтра. Возможные фильтры см. по адресу https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeRegions.html. Имена и значения фильтров чувствительны к регистру. Вы можете использовать подчеркивания вместо дефисов (-) в ключах фильтров. Ключи фильтров с подчеркиваниями имеют приоритет в случае конфликта.
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 security token. Если не задан, используется значение переменной окружения 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

Примеры

# Note: These examples do not set authentication details, see the AWS Guide for details.

# Gather information about all regions
- community.aws.aws_region_info:

# Gather information about a single region
- community.aws.aws_region_info:
    filters:
      region-name: eu-west-1

Значения возврата

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

Ключ	Возвращаемое значение	Описание
regions список / элементы=строка	при успехе	Регионы, соответствующие предоставленным фильтрам. Каждый элемент представляет собой словарь со всей информацией о регионе. Пример: [{ 'endpoint': 'ec2.us-west-1.amazonaws.com', 'region_name': 'us-west-1' }]

Авторы

Henrique Rodrigues (@Sodki)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/aws/aws_region_info_module.html