Spec-Zone.ru › Ansible 2.6

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 идентификатора доступа к источнику для получения информации.
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_config Значение по умолчанию:
"нет"
Получить конфигурационную информацию о заданном распределении RTMP. Требуется указать distribution_id или domain_name_alias.
summary Значение по умолчанию:
"нет"
Возвращает сводку всех распределений, потоковых распределений и идентификаторов доступа к источнику. Это поведение по умолчанию, если не выбран другой вариант.
validate_certs
bool

(добавлено в 1.5)
    Варианты:
  • нет
  • да ←
Если установлено значение "нет", сертификаты 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), если учетные данные не предоставлены. См. http://boto.readthedocs.org/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
dict
только если distribution равно true
Информация о распределении cloudfront. Требуется указать distribution_id или domain_name_alias. Требуется установить origin_access_identity_id.

distribution_config
dict
только если distribution_config равно true
Информация о конфигурации распределения cloudfront. Требуется указать distribution_id или domain_name_alias.

invalidation
dict
только если invalidation равно true
Описание информации о проверке валидности для распределения. Требуется указать invalidation_id и либо distribution_id, либо domain_name_alias.

origin_access_identity
dict
только если origin_access_identity равно true
Описание информации об идентификаторе доступа к источнику. Требуется установить origin_access_identity_id.

origin_access_identity_configuration
dict
только если origin_access_identity_configuration равно true
Описание конфигурации информации об идентификаторе доступа к источнику. Требуется установить origin_access_identity_id.

streaming_distribution
dict
только если streaming_distribution равно true
Описание информации о потоковом распределении. Требуется указать distribution_id или domain_name_alias.

streaming_distribution_config
dict
только если streaming_distribution_config равно true
Описание конфигурации информации о потоковом распределении. Требуется указать distribution_id или domain_name_alias.

summary
dict
по умолчанию или если summary равно true
Предоставляет сводку по распределениям, потоковым распределениям и идентификаторам доступа к источнику.



Статус

Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость интерфейса.

Техническое обслуживание

Этот модуль помечен как сообщество, что означает, что он поддерживается сообществом Ansible. Более подробную информацию см. в разделе Техническое обслуживание и поддержка модулей.

Список других модулей, также поддерживаемых сообществом Ansible, см. в разделе здесь.

Автор

  • 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.6/modules/cloudfront_facts_module.html

Spec-Zone.ru

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