community.aws.cloudfront_facts – Получение фактов о распределении AWS CloudFront
Примечание
Этот плагин входит в коллекцию community.aws (версия 1.3.0).
Для его установки используйте: ansible-galaxy collection install community.aws.
Чтобы использовать его в книге задач, укажите: community.aws.cloudfront_facts.
Новый в версии 1.0.0: из community.aws
Описание
- Получает информацию о распределении AWS CloudFront.
- Этот модуль назывался
cloudfront_factsдо Ansible 2.9, возвращаяansible_facts. Обратите внимание, что модуль community.aws.cloudfront_info больше не возвращаетansible_facts!
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- boto
- boto3 >= 1.0.0
- python >= 2.6
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| all_lists boolean |
| Получить все списки CloudFront, для которых не требуются параметры. |
| 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-сертификатов для проверки SSL-сертификатов. Используется только для модулей, основанных на boto3. Примечание: Набор CA-сертификатов читается модулем и может потребоваться явное копирование из контроллера, если модуль не выполняется локально. | |
| 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 boolean |
| Использовать логгер botocore.endpoint для парсинга уникальных (а не общих) API-вызовов "ресурс:действие", совершённых во время задачи, выводя набор в ключ resource_actions результатов задачи. Используйте обратный вызов aws_resource_action для вывода в итоговый список, созданный во время выполнения плейбука. Также может использоваться переменная среды ANSIBLE_DEBUG_BOTOCORE_LOGS. |
| distribution boolean |
| Получить информацию о распределении. Требуется указать distribution_id или domain_name_alias. |
| distribution_config boolean |
| Получить конфигурационную информацию о распределении. Требуется указать 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, если таковая есть. псевдонимы: aws_endpoint_url, endpoint_url | |
| invalidation boolean |
| Получить информацию об аннулировании. Требуется указать invalidation_id. |
| invalidation_id строка | Идентификатор аннулирования для получения информации. Используется с invalidation. | |
| list_distributions boolean |
| Получить список распределений CloudFront. |
| list_distributions_by_web_acl_id boolean |
| Получить список распределений, используя идентификатор web acl в качестве фильтра. Требуется указать web_acl_id. |
| list_invalidations boolean |
| Получить список аннулирований. Требуется указать distribution_id или domain_name_alias. |
| list_origin_access_identities boolean |
| Получить список идентификаторов доступа к источнику CloudFront. Требуется указать origin_access_identity_id. |
| list_streaming_distributions boolean |
| Получить список потоковых распределений. |
| origin_access_identity boolean |
| Получить информацию об идентификаторе доступа к источнику. Требуется указать origin_access_identity_id. |
| origin_access_identity_config boolean |
| Получить конфигурационную информацию об идентификаторе доступа к источнику. Требуется указать origin_access_identity_id. |
| origin_access_identity_id строка | Идентификатор идентификатора доступа к источнику CloudFront для получения информации. | |
| 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. Если не задан, используется значение переменной среды AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. Если задан параметр profile, этот параметр игнорируется. Одновременное использование параметров security_token и profile устарело и будет сделано взаимоисключающим после 2022-06-01. псевдонимы: aws_security_token, access_token | |
| streaming_distribution boolean |
| Получить информацию о заданном распределении RTMP. Требуется указать distribution_id или domain_name_alias. |
| streaming_distribution_config boolean |
| Получить конфигурационную информацию о заданном распределении RTMP. Требуется указать distribution_id или domain_name_alias. |
| summary boolean |
| Возвращает сводку всех распределений, потоковых распределений и идентификаторов доступа к источнику. Это поведение по умолчанию, если не выбран ни один параметр. |
| validate_certs boolean |
| При установке в «нет» 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.
- name: Get a summary of distributions
community.aws.cloudfront_info:
summary: true
register: result
- name: Get information about a distribution
community.aws.cloudfront_info:
distribution: true
distribution_id: my-cloudfront-distribution-id
register: result_did
- ansible.builtin.debug:
msg: "{{ result_did['cloudfront']['my-cloudfront-distribution-id'] }}"
- name: Get information about a distribution using the CNAME of the cloudfront distribution.
community.aws.cloudfront_info:
distribution: true
domain_name_alias: www.my-website.com
register: result_website
- ansible.builtin.debug:
msg: "{{ result_website['cloudfront']['www.my-website.com'] }}"
# When the module is called as cloudfront_facts, return values are published
# in ansible_facts['cloudfront'][<id>] and can be used as follows.
# Note that this is deprecated and will stop working in Ansible 2.13.
- name: Gather facts
community.aws.cloudfront_facts:
distribution: true
distribution_id: my-cloudfront-distribution-id
- ansible.builtin.debug:
msg: "{{ ansible_facts['cloudfront']['my-cloudfront-distribution-id'] }}"
- community.aws.cloudfront_facts:
distribution: true
domain_name_alias: www.my-website.com
- ansible.builtin.debug:
msg: "{{ ansible_facts['cloudfront']['www.my-website.com'] }}"
- name: Get all information about an invalidation for a distribution.
community.aws.cloudfront_info:
invalidation: true
distribution_id: my-cloudfront-distribution-id
invalidation_id: my-cloudfront-invalidation-id
- name: Get all information about a CloudFront origin access identity.
community.aws.cloudfront_info:
origin_access_identity: true
origin_access_identity_id: my-cloudfront-origin-access-identity-id
- name: Get all information about lists not requiring parameters (ie. list_origin_access_identities, list_distributions, list_streaming_distributions)
community.aws.cloudfront_info:
origin_access_identity: true
origin_access_identity_id: my-cloudfront-origin-access-identity-id
- name: Get all information about lists not requiring parameters (ie. list_origin_access_identities, list_distributions, list_streaming_distributions)
community.aws.cloudfront_info:
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. |
| result словарь | всегда | Словарь result не вложен в CloudFront ID для доступа к результатам модуля без знания этого ID, так как определение DistributionId обычно является причиной использования этого модуля в первую очередь. |
| 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 | Предоставляет сводку распределений, потоковых распределений и идентификаторов доступа к источнику. |
Авторы
- 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.10/collections/community/aws/cloudfront_facts_module.html