cloudfront_facts - Получение фактов о распределении AWS CloudFront
Новая версия 2.3.
- Описание
- Требования (для хоста, на котором выполняется модуль)
- Параметры
- Примеры
- Значения возврата
- Примечания
Описание
- Получает информацию о распределении AWS CloudFront
Требования (для хоста, на котором выполняется модуль)
- boto
- boto3 >= 1.0.0
- python >= 2.6
Параметры
| параметр | обязательный | по умолчанию | выбор | комментарии |
|---|---|---|---|---|
| all_lists | нет | Получить все списки cloudfront, не требующие параметров. | ||
| aws_access_key | нет | Ключ доступа AWS. Если не задан, используется значение переменной окружения AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY. псевдонимы: ec2_access_key, access_key | ||
| aws_secret_key | нет | Секретный ключ AWS. Если не задан, используется значение переменной окружения AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY. псевдонимы: ec2_secret_key, secret_key | ||
| distribution | нет | Получить информацию о распределении. Требуется указать distribution_id или domain_name_alias. | ||
| distribution_config | нет | Получить конфигурацию информации о распределении. Требуется указать distribution_id или domain_name_alias. | ||
| distribution_id | нет | Идентификатор распределения CloudFront. Используется с параметрами distribution, distribution_config, invalidation, streaming_distribution, streaming_distribution_config, list_invalidations. | ||
| domain_name_alias | нет | Можно использовать вместо distribution_id - использует алиасовый CNAME для распределения cloudfront для получения идентификатора распределения, где это необходимо. | ||
| ec2_url | нет | URL для подключения к облаку EC2 или Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где необходим регион. Должен быть указан для всех других модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если таковое имеется. | ||
| invalidation | нет | Получить информацию об аннулировании. Требуется указать invalidation_id. | ||
| invalidation_id | нет | Идентификатор аннулирования для получения информации. Используется с параметром invalidation. | ||
| list_distributions | нет | Получить список распределений cloudfront. | ||
| list_distributions_by_web_acl_id | нет | Получить список распределений, используя идентификатор web acl в качестве фильтра. Требуется установить web_acl_id. | ||
| list_invalidations | нет | Получить список аннулирований. Требуется указать distribution_id или domain_name_alias. | ||
| list_origin_access_identities | нет | Получить список идентификаторов доступа к источнику cloudfront. Требуется установить origin_access_identity_id. | ||
| list_streaming_distributions | нет | Получить список потоковых распределений. | ||
| origin_access_identity | нет | Получить информацию об идентификаторе доступа к источнику. Требуется указать origin_access_identity_id. | ||
| origin_access_identity_config | нет | Получить конфигурацию информации об идентификаторе доступа к источнику. Требуется указать origin_access_identity_id. | ||
| origin_access_identity_id | нет | Идентификатор cloudfront origin access identity для получения информации. | ||
| profile (добавлено в 1.6)
| нет | Использует профиль boto. Работает только с boto >= 2.24.0. | ||
| region | нет | Регион AWS для использования. Если не указан, используется значение переменной окружения AWS_REGION или EC2_REGION, если таковая имеется. См. http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region
псевдонимы: aws_region, ec2_region | ||
| security_token (добавлено в 1.6)
| нет | Токен безопасности AWS STS. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. псевдонимы: access_token | ||
| streaming_distribution | нет | Получить информацию о заданном RTMP распределении. Требуется указать distribution_id или domain_name_alias. | ||
| streaming_distribution_configuration | нет | Получить конфигурацию информации о заданном RTMP распределении. Требуется указать distribution_id или domain_name_alias. | ||
| summary | нет | Возвращает сводку всех распределений, потоковых распределений и origin_access_identities. Это поведение по умолчанию, если не выбран ни один параметр. | ||
| validate_certs (добавлено в 1.5)
| нет | да |
| Если установлено «нет», сертификаты SSL не будут проверяться для версий boto >= 2.6.0. |
| web_acl_id | нет | Используется с list_distributions_by_web_acl_id. |
Примеры
# Note: These examples do not set authentication details, see the AWS Guide for details.
# Get a summary of distributions
- cloudfront_facts:
summary: true
# Get information about a distribution
- cloudfront_facts:
distribution: true
distribution_id: my-cloudfront-distribution-id
# Get information about a distribution using the CNAME of the cloudfront distribution.
- cloudfront_facts:
distribution: true
domain_name_alias: www.my-website.com
# Facts are published in ansible_facts['cloudfront'][<distribution_name>]
- debug:
msg: "{{ ansible_facts['cloudfront']['my-cloudfront-distribution-id'] }}"
- debug:
msg: "{{ ansible_facts['cloudfront']['www.my-website.com'] }}"
# Get all information about an invalidation for a distribution.
- cloudfront_facts:
invalidation: true
distribution_id: my-cloudfront-distribution-id
invalidation_id: my-cloudfront-invalidation-id
# Get all information about a cloudfront origin access identity.
- cloudfront_facts:
origin_access_identity: true
origin_access_identity_id: my-cloudfront-origin-access-identity-id
# Get all information about lists not requiring parameters (ie. list_origin_access_identities, list_distributions, list_streaming_distributions)
- cloudfront_facts:
origin_access_identity: true
origin_access_identity_id: my-cloudfront-origin-access-identity-id
# Get all information about lists not requiring parameters (ie. list_origin_access_identities, list_distributions, list_streaming_distributions)
- cloudfront_facts:
all_lists: true
Значения возврата
Общие значения возврата описаны здесь Значения возврата, следующие поля уникальны для данного модуля:
| имя | описание | возвращается | тип | пример |
|---|---|---|---|---|
| distribution | Факты о распределении cloudfront. Требуется указать distribution_id или domain_name_alias. Требуется установить origin_access_identity_id. | только если distribution равно true | dict | |
| distribution_config | Факты о конфигурации распределения cloudfront. Требуется указать distribution_id или domain_name_alias. | только если I(distribution_config) равно true | dict | |
| invalidation | Описание информации об аннулировании для распределения. Требуется указать invalidation_id и либо distribution_id, либо domain_name_alias. | только если invalidation равно true | dict | |
| origin_access_identity | Описание информации об идентификаторе доступа к источнику. Требуется установить origin_access_identity_id. | только если I(origin_access_identity) равно true | dict | |
| origin_access_identity_configuration | Описание конфигурации информации об идентификаторе доступа к источнику. Требуется установить origin_access_identity_id. | только если I(origin_access_identity_configuration) равно true | dict | |
| streaming_distribution | Описание потоковой информации для распределения. Требуется указать distribution_id или domain_name_alias. | только если I(streaming_distribution) равно true | dict | |
| streaming_distribution_configuration | Описание конфигурации потоковой информации для распределения. Требуется указать distribution_id или domain_name_alias. | только если I(streaming_distribution_configuration) равно true | dict | |
| summary | Предоставляет сводку распределений, потоковых распределений и идентификаторов доступа к источнику. | по умолчанию или если summary равно true | dict |
Примечания
Примечание
- Если параметры не заданы в модуле, следующие переменные окружения могут использоваться в порядке убывания приоритета
AWS_URLилиEC2_URL,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 - Ansible использует файл конфигурации boto (обычно ~/.boto), если учетные данные не предоставлены. См. http://boto.readthedocs.org/en/latest/boto_config_tut.html
-
AWS_REGIONилиEC2_REGIONобычно используются для указания региона AWS, когда это требуется, но это также можно настроить в файле конфигурации boto
Статус
Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость интерфейса.
Для помощи в разработке модулей, если у вас есть такое желание, пожалуйста, прочтите Информация о сообществе и участие в разработке, Тестирование Ansible и Разработка модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/cloudfront_facts_module.html