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 | |
| debug_botocore_endpoint_logs логическое добавлено в 2.8 |
| Использовать регистратор botocore.endpoint для анализа уникальных (а не общих) вызовов API "resource:action", выполненных во время задачи, выводя набор в ключ resource_actions в результатах задачи. Используйте обратный вызов aws_resource_action для вывода в общий список, созданный во время выполнения playbook. Может также использоваться переменная среды ANSIBLE_DEBUG_BOTOCORE_LOGS. |
| 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, о котором необходимо получить информацию. | |
| profile строка | Использует профиль 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 строка | Маркер безопасности AWS STS. Если не задан, используется значение переменной среды AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. псевдонимы: access_token | |
| streaming_distribution логическое |
| Получить информацию об указанном дистрибутиве RTMP. Требуется указать distribution_id или domain_name_alias. |
| streaming_distribution_config логическое |
| Получить информацию о конфигурации указанного дистрибутива RTMP. Требуется указать distribution_id или domain_name_alias. |
| summary логическое |
| Возвращает сводку по всем дистрибутивам, потоковым дистрибутивам и origin_access_identities. Это поведение по умолчанию, если ни один параметр не выбран. |
| validate_certs логическое |
| При установке значения "нет" SSL-сертификаты не будут проверяться для версий boto >= 2.6.0. |
| web_acl_id - | Используется с list_distributions_by_web_acl_id. |
Примечания
Примечание
- Если параметры не заданы в модуле, можно использовать следующие переменные среды в порядке убывания приоритета
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), если учетные данные не предоставлены. См. 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.
# 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 словарь | только если distribution равно true | Информация о распределении cloudfront. Требуется указать distribution_id или domain_name_alias. Требуется установить origin_access_identity_id. |
| distribution_config словарь | только если distribution_config равно true | Информация о конфигурации распределения cloudfront. Требуется указать distribution_id или domain_name_alias. |
| invalidation словарь | только если invalidation равно true | Описание информации о недействительности для распределения. Требуется указать invalidation_id и либо distribution_id, либо domain_name_alias.
|
| origin_access_identity словарь | только если origin_access_identity равно true | Описание информации об идентификаторе доступа к источнику. Требуется установить origin_access_identity_id. |
| origin_access_identity_configuration словарь | только если origin_access_identity_configuration равно true | Описание конфигурации информации об идентификаторе доступа к источнику. Требуется установить origin_access_identity_id. |
| streaming_distribution словарь | только если streaming_distribution равно true | Описание потоковой информации для распределения. Требуется указать distribution_id или domain_name_alias. |
| streaming_distribution_config словарь | только если streaming_distribution_config равно true | Описание конфигурации потоковой информации для распределения. Требуется указать distribution_id или domain_name_alias. |
| summary словарь | по умолчанию или если summary равно true | Предоставляет сводку распределений, потоковых распределений и идентификаторов доступа к источникам. |
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- Willem van Ketwich (@wilvk)
Подсказка
Если вы обнаружите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/cloudfront_facts_module.html