Модуль amazon.aws.aws_az_info — сбор информации о зонах доступности в AWS
Примечание
Этот модуль входит в коллекцию amazon.aws (версия 11.3.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install amazon.aws. Для работы с этим модулем требуются дополнительные компоненты. Подробнее см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: amazon.aws.aws_az_info.
Добавлено в amazon.aws 1.0.0
Краткое описание
- Сбор информации о зонах доступности в AWS.
Требования
На узле, выполняющем этот модуль, должны быть установлены следующие компоненты.
- python >= 3.6
- boto3 >= 1.35.0
- botocore >= 1.35.0
Параметры
Параметр | Комментарии |
|---|---|
access_key псевдонимы: aws_access_key_id, aws_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 для согласованности с AWS SDK botocore. |
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 псевдонимы: aws_endpoint_url строка | URL-адрес для подключения вместо конечных точек AWS по умолчанию. Хотя этот параметр можно использовать для подключения к другим сервисам, совместимым с AWS, коллекции amazon.aws и community.aws тестируются только с AWS. Также можно использовать переменную окружения |
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. Также можно использовать переменную окружения Параметр profile взаимоисключающий с параметрами aws_access_key, aws_secret_key и session_token. |
region псевдонимы: aws_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 строка | Секретный ключ доступа 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 для согласованности с AWS SDK botocore. |
session_token псевдонимы: aws_session_token строка | Токен сеанса 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 являются взаимоисключающими. |
validate_certs логическое значение | Если задано значение Настоятельно не рекомендуется устанавливать validate_certs=false; в качестве альтернативы рассмотрите возможность задать параметр aws_ca_bundle. Варианты:
|
Примечания
Примечание
- Внимание: Для модулей переменные окружения и файлы конфигурации считываются из контекста «узла» Ansible, а не из контекста «контроллера». Поэтому файлы может потребоваться явно скопировать на «узел». Для подключаемых модулей поиска и подключения переменные окружения и файлы конфигурации считываются из контекста «контроллера» Ansible, а не из контекста «узла».
- Используемый Ansible AWS SDK (boto3) также может считывать значения по умолчанию для учётных данных и других параметров, например региона, из файлов конфигурации в контексте «узла» 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 строка |
Имя связанной группы. Для зон доступности это значение совпадает с Возвращается: при успехе Пример: |
|
messages список / элементы=словарь |
Список сообщений о зоне доступности. Возвращается: при успехе Пример: |
|
message строка |
Сообщение о зоне доступности. Возвращается: при успехе Пример: |
|
network_border_group строка |
Имя группы сетевой границы. Возвращается: при успехе Пример: |
|
opt_in_status строка |
Статус подписки. Для зон доступности значение всегда равно Возвращается: при успехе Пример: |
|
region_name строка |
Название региона. Возвращается: при успехе Пример: |
|
state строка |
Состояние зоны доступности. Значение всегда равно Возвращается: при успехе Пример: |
|
zone_id строка |
Идентификатор зоны доступности. Возвращается: при успехе Пример: |
|
zone_name строка |
Название зоны доступности. Возвращается: при успехе Пример: |
|
zone_type строка |
Тип зоны. Возвращается: при успехе Пример: |
Ссылки на коллекцию
© 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_az_info_module.html