Spec-Zone.ru › Ansible

amazon.aws.aws_az_info модуль – Сбор информации о зонах доступности в AWS

Примечание

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

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

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

Для использования в playbook укажите: amazon.aws.aws_az_info.

Новая в amazon.aws 1.0.0

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

Описание

  • Сбор информации о зонах доступности в AWS.

Требования

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

  • 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_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY в порядке убывания приоритета.

Параметры aws_access_key и profile взаимоисключающие.

Псевдоним aws_access_key_id был добавлен в релизе 5.1.0 для согласованности с AWS botocore SDK.

Псевдоним ec2_access_key устарел и будет удален в релизе после 2024-12-01.

Поддержка переменной среды EC2_ACCESS_KEY устарела и будет удалена в релизе после 2024-12-01.

aws_ca_bundle

путь

Расположение файла с набором сертификатов CA для проверки SSL-сертификатов.

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

aws_config

словарь

Словарь для изменения конфигурации botocore.

Параметры можно найти в документации AWS https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.

debug_botocore_endpoint_logs

логический тип

Используйте botocore.endpoint логгер для анализа уникальных (а не общих) "resource:action" API-вызовов, выполненных во время задачи, выводив набор в ключ resource_actions результатов задачи. Используйте aws_resource_action обратный вызов для вывода в общий список, выполненный во время выполнения playbook.

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

Варианты:

  • false ← (по умолчанию)
  • true

endpoint_url

псевдонимы: ec2_url, aws_endpoint_url, s3_url

строка

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

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

Псевдонимы ec2_url и s3_url устарели и будут удалены в релизе после 2024-12-01.

Поддержка переменной среды EC2_URL устарела и будет удалена в релизе после 2024-12-01.

filters

словарь

Словарь фильтров для применения.

Каждый элемент словаря состоит из ключа фильтра и значения фильтра.

Возможные фильтры см. в https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeAvailabilityZones.html.

Имена и значения фильтров чувствительны к регистру.

Вы можете использовать символы подчеркивания вместо дефисов (-) в ключах фильтров.

Ключи фильтров с подчеркиваниями будут иметь приоритет в случае конфликта.

По умолчанию: {}

profile

псевдонимы: aws_profile

строка

Используемый именованный профиль AWS для аутентификации.

Дополнительную информацию об именованных профилях см. в документации AWS https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html.

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

Параметр profile взаимоисключающий с параметрами aws_access_key, aws_secret_key и security_token.

region

псевдонимы: aws_region, ec2_region

строка

Используемый регион AWS.

Для глобальных служб, таких как IAM, Route53 и CloudFront, region игнорируется.

Также можно использовать переменные среды AWS_REGION или EC2_REGION.

Дополнительную информацию см. в документации Amazon AWS http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region.

Псевдоним ec2_region устарел и будет удален в релизе после 2024-12-01.

Поддержка переменной среды EC2_REGION устарела и будет удалена в релизе после 2024-12-01.

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.

Также можно использовать переменные среды AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, или EC2_SECRET_KEY в порядке убывания приоритета.

Параметры secret_key и profile взаимоисключающие.

Псевдоним aws_secret_access_key был добавлен в релизе 5.1.0 для согласованности с AWS botocore SDK.

Псевдоним ec2_secret_key устарел и будет удален в релизе после 2024-12-01.

Поддержка переменной среды 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.

Также можно использовать переменные среды AWS_SESSION_TOKEN, AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN в порядке убывания приоритета.

Параметры 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.

Поддержка переменных среды EC2_SECRET_KEY и AWS_SECURITY_TOKEN устарела и будет удалена в релизе после 2024-12-01.
END_OF_DOCUMENT_MARKER

validate_certs

boolean

При установке в false, сертификаты SSL не будут проверяться при общении с API AWS.

Настройка validate_certs=false категорически не рекомендуется. Вместо этого следует настроить aws_ca_bundle.

Варианты:

  • false
  • true ← (по умолчанию)

Примечания

Примечание

  • Внимание: Для модулей переменные окружения и конфигурационные файлы считываются из контекста хоста Ansible, а не из контекста контроллера. Поэтому файлы может потребоваться скопировать на хост. Для плагинов поиска и подключения переменные окружения и конфигурационные файлы считываются из контекста контроллера Ansible, а не из контекста хоста.
  • AWS SDK (boto3), используемый Ansible, также может считывать значения по умолчанию для учетных данных и других параметров, таких как регион, из своих конфигурационных файлов в контексте хоста Ansible (обычно ~/.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: Gather information about all availability zones
  amazon.aws.aws_az_info:

- name: Gather information about a single availability zone
  amazon.aws.aws_az_info:
    filters:
      zone-name: eu-west-1a

- name: Gather information in a availability zones based on their state, such as "available"
  amazon.aws.aws_az_info:
    region: us-east-1
    filters:
      state: available

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

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

Ключ

Описание

availability_zones

список / элементы=словарь

Доступные зоны, соответствующие предоставленным фильтрам. Каждый элемент представляет собой словарь со всей информацией об этой доступной зоне.

Возвращается: при успехе

Пример: [{"group_name": "us-east-1", "messages": [], "network_border_group": "us-east-1", "opt_in_status": "opt-in-not-required", "region_name": "us-east-1", "state": "available", "zone_id": "use1-az6", "zone_name": "us-east-1a", "zone_type": "availability-zone"}, {"group_name": "us-east-1", "messages": [], "network_border_group": "us-east-1", "opt_in_status": "opt-in-not-required", "region_name": "us-east-1", "state": "available", "zone_id": "use1-az1", "zone_name": "us-east-1b", "zone_type": "availability-zone"}]

group_name

строка

Название связанной группы.

Для доступных зон это будет то же, что и availability_zones.region_name.

Возвращается: при успехе

Пример: "us-east-1"

messages

список / элементы=словарь

Список сообщений о доступной зоне.

Возвращается: при успехе

Пример: [{"message": "message_one"}, {"message": "message_two"}]

message

строка

Сообщение о доступной зоне.

Возвращается: при успехе

Пример: "msg"

network_border_group

строка

Название группы сетевого border.

Возвращается: при успехе

Пример: "us-east-1"

opt_in_status

строка

Статус opt-in.

Значение всегда opt-in-not-required для доступных зон.

Возвращается: при успехе

Пример: "opt-in-not-required"

region_name

строка

Название региона.

Возвращается: при успехе

Пример: "us-east-1"

state

строка

Состояние доступной зоны.

Значение всегда available.

Возвращается: при успехе

Пример: "available"

zone_id

строка

Идентификатор доступной зоны.

Возвращается: при успехе

Пример: "use1-az5"

zone_name

строка

Название доступной зоны.

Возвращается: при успехе

Пример: "us-east-1e"

zone_type

строка

Тип зоны.

Возвращается: при успехе

Пример: "availability-zone"

Авторы

  • Henrique Rodrigues (@Sodki)

Ссылки на коллекцию

  • Система отслеживания задач
  • Репозиторий (источники)
  • Связь

© 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_az_info_module.html

Spec-Zone.ru

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