Spec-Zone.ru › Ansible 2.9

cloudfront_info – Получение фактов о распределении AWS CloudFront

  • Описание
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения
  • Статус

Описание

  • Получает информацию о распределении AWS CloudFront
  • Этот модуль назывался cloudfront_facts до Ansible 2.9, возвращая ansible_facts. Обратите внимание, что модуль cloudfront_info больше не возвращает ansible_facts!

Псевдонимы: cloudfront_facts

Требования

Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.

  • boto
  • boto3 >= 1.0.0
  • python >= 2.6

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
all_lists
boolean
    Варианты:
  • нет ←
  • да
Получить все списки cloudfront, которые не требуют параметров.
aws_access_key
string
Ключ доступа AWS. Если не задан, используется значение переменной окружения AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY.

Псевдонимы: ec2_access_key, access_key
aws_secret_key
string
Секретный ключ AWS. Если не задан, используется значение переменной окружения AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY.

Псевдонимы: ec2_secret_key, secret_key
debug_botocore_endpoint_logs
boolean
добавлен в 2.8
    Варианты:
  • нет ←
  • да
Использовать логгер 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 для получения ID распределения, где это необходимо.
ec2_url
string
URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль будет использовать конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех остальных модулей, если регион не используется. Если не задан, используется значение переменной среды EC2_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
string
Использует профиль boto. Работает только с boto >= 2.24.0.
region
string
AWS регион для использования. Если не указан, используется значение переменной окружения AWS_REGION или EC2_REGION, если таковая имеется. См. http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region

Псевдонимы: aws_region, ec2_region
security_token
string
AWS STS токен безопасности. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_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
    Варианты:
  • нет ←
  • да
Возвращает сводку всех распределений, потоковых распределений и origin_access_identities. Это поведение по умолчанию, если не выбран другой вариант.
validate_certs
boolean
  • нет
  • да ←
При установке в «нет», сертификаты 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_info:
    summary: true
  register: result

# Get information about a distribution
- cloudfront_info:
    distribution: true
    distribution_id: my-cloudfront-distribution-id
  register: result_did
- debug:
    msg: "{{ result_did['cloudfront']['my-cloudfront-distribution-id'] }}"

# Get information about a distribution using the CNAME of the cloudfront distribution.
- cloudfront_info:
    distribution: true
    domain_name_alias: www.my-website.com
  register: result_website
- 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.
- cloudfront_facts:
    distribution: true
    distribution_id: my-cloudfront-distribution-id
- debug:
    msg: "{{ ansible_facts['cloudfront']['my-cloudfront-distribution-id'] }}"

- cloudfront_facts:
    distribution: true
    domain_name_alias: www.my-website.com
- 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 истинно
Сведения о распределении cloudfront. Требуется указать distribution_id или domain_name_alias. Требуется установить origin_access_identity_id.

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

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

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

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

result
словарь
всегда
Словарь результатов, не вложенный в cloudfront id для доступа к результатам модуля без знания этого id, так как определение DistributionId обычно является причиной использования этого модуля в первую очередь.

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

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

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



Статус

  • Данный модуль не гарантирует обратную совместимость интерфейса. [preview]
  • Этот модуль поддерживается сообществом 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.9/modules/cloudfront_info_module.html

Spec-Zone.ru

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