Spec-Zone.ru › Ansible

community.aws.cloudfront_distribution_info модуль – Получение данных об AWS CloudFront распределении

Примечание

Этот модуль является частью коллекции community.aws (версия 8.0.0).

Эта коллекция может быть уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.aws. Для использования этого модуля необходимы дополнительные требования. Подробности см. в разделе Требования.

Для использования в плейбуке укажите: community.aws.cloudfront_distribution_info.

Новый в community.aws 1.0.0

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

Описание

  • Получает информацию об AWS CloudFront распределении.
  • До версии 5.0.0 этот модуль назывался community.aws.cloudfront_info. Использование не изменилось.

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

Требования

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

  • python >= 3.6
  • boto3 >= 1.26.0
  • botocore >= 1.29.0

Параметры

Параметр

Комментарии

access_key

aliases: aws_access_key_id, aws_access_key, ec2_access_key

string

Идентификатор ключа доступа AWS.

См. документацию AWS для получения дополнительной информации о токенах доступа https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys.

Переменные среды AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY также могут использоваться в порядке убывания предпочтения.

Параметры aws_access_key и profile являются взаимоисключающими.

Псевдоним aws_access_key_id был добавлен в версии 5.1.0 для согласованности с SDK AWS botocore.

Псевдоним ec2_access_key устарел и будет удален в релизе после 2024-12-01.

Поддержка переменной среды EC2_ACCESS_KEY устарела и будет удалена в релизе после 2024-12-01.

all_lists

boolean

Получить все списки CloudFront, которые не требуют параметров.

Варианты:

  • false ← (по умолчанию)
  • true

aws_ca_bundle

path

Расположение пакета CA, используемого при проверке SSL-сертификатов.

Переменная среды AWS_CA_BUNDLE также может использоваться.

aws_config

dictionary

Словарь для изменения конфигурации botocore.

Параметры можно найти в документации AWS https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.

debug_botocore_endpoint_logs

boolean

Использовать botocore.endpoint регистратор для анализа уникальных (а не общих) "resource:action" вызовов API, сделанных во время задачи, выводя набор в ключ resource_actions в результатах задачи. Используйте обратный вызов aws_resource_action для вывода в общий список, созданный во время playbook.

Переменная среды ANSIBLE_DEBUG_BOTOCORE_LOGS также может использоваться.

Варианты:

  • false ← (по умолчанию)
  • true

distribution

boolean

Получить информацию о дистрибутиве.

Требуется указать distribution_id или domain_name_alias.

Варианты:

  • false ← (по умолчанию)
  • true

distribution_config

boolean

Получить информацию о конфигурации дистрибутива.

Требуется указать distribution_id или domain_name_alias.

Варианты:

  • false ← (по умолчанию)
  • true

distribution_id

string

Идентификатор дистрибутива CloudFront. Используется с distribution, distribution_config, invalidation, streaming_distribution, streaming_distribution_config, list_invalidations.

domain_name_alias

string

Может использоваться вместо distribution_id - использует псевдоним CNAME для дистрибутива CloudFront для получения идентификатора дистрибутива, где это необходимо.

endpoint_url

aliases: ec2_url, aws_endpoint_url, s3_url

string

URL для подключения вместо стандартных конечных точек AWS. Хотя это может использоваться для подключения к другим совместимым с AWS сервисам, коллекции amazon.aws и community.aws тестируются только с AWS.

Переменные среды AWS_URL или EC2_URL также могут использоваться в порядке убывания предпочтения.

Псевдонимы ec2_url и s3_url устарели и будут удалены в релизе после 2024-12-01.

Поддержка переменной среды EC2_URL устарела и будет удалена в релизе после 2024-12-01.

invalidation

boolean

Получить информацию об аннулировании.

Требуется указать invalidation_id.

Варианты:

  • false ← (по умолчанию)
  • true

invalidation_id

string

Идентификатор аннулирования, о котором нужно получить информацию.

Используется с invalidation.

list_distributions

boolean

Получить список дистрибутивов CloudFront.

Варианты:

  • false ← (по умолчанию)
  • true

list_distributions_by_web_acl_id

boolean

Получить список дистрибутивов, используя web acl id в качестве фильтра.

Требуется установить web_acl_id.

Варианты:

  • false ← (по умолчанию)
  • true

list_invalidations

boolean

Получить список аннулирований.

Требуется указать distribution_id или domain_name_alias.

Choices:

  • false ← (default)
  • true

list_origin_access_identities

boolean

Получить список идентификаторов доступа к источнику CloudFront.

Требуется установить origin_access_identity_id.

Choices:

  • false ← (default)
  • true

list_streaming_distributions

boolean

Получить список потоковых дистрибуций.

Choices:

  • false ← (default)
  • true

origin_access_identity

boolean

Получить информацию об идентификаторе доступа к источнику.

Требуется указать origin_access_identity_id.

Choices:

  • false ← (default)
  • true

origin_access_identity_config

boolean

Получить информацию о конфигурации идентификатора доступа к источнику.

Требуется указать origin_access_identity_id.

Choices:

  • false ← (default)
  • true

origin_access_identity_id

string

Идентификатор идентификатора доступа к источнику CloudFront, о котором нужно получить информацию.

profile

aliases: aws_profile

string

Именованный профиль AWS для использования при аутентификации.

См. документацию AWS для получения дополнительной информации об именованных профилях https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html.

Также может использоваться переменная среды AWS_PROFILE.

Параметр profile является взаимоисключающим с параметрами aws_access_key, aws_secret_key и security_token.

region

aliases: aws_region, ec2_region

string

Регион AWS для использования.

Для глобальных служб, таких как IAM, Route53 и CloudFront, region игнорируется.

Также могут использоваться переменные среды AWS_REGION или EC2_REGION.

См. документацию Amazon AWS для получения дополнительной информации http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region.

Псевдоним ec2_region устарел и будет удален в релизе после 2024-12-01

Поддержка переменной среды EC2_REGION устарела и будет удалена в релизе после 2024-12-01.

secret_key

aliases: aws_secret_access_key, aws_secret_key, ec2_secret_key

string

Секретный ключ доступа AWS.

См. документацию AWS для получения дополнительной информации о токенах доступа https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys.

Также могут использоваться переменные среды AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY в порядке убывания предпочтения.

Параметры secret_key и profile являются взаимоисключающими.

Псевдоним aws_secret_access_key был добавлен в релизе 5.1.0 для согласованности с AWS botocore SDK.

Псевдоним ec2_secret_key устарел и будет удален в релизе после 2024-12-01.

Поддержка переменной среды EC2_SECRET_KEY устарела и будет удалена в релизе после 2024-12-01.

session_token

aliases: aws_session_token, security_token, aws_security_token, access_token

string

Сеансовый токен AWS STS для использования с временными учетными данными.

См. документацию AWS для получения дополнительной информации о токенах доступа https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys.

Также могут использоваться переменные среды AWS_SESSION_TOKEN, AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN в порядке убывания предпочтения.

Параметры security_token и profile являются взаимоисключающими.

Псевдонимы aws_session_token и session_token были добавлены в релизе 3.2.0, а параметр был переименован из security_token в session_token в релизе 6.0.0.

Псевдонимы security_token, aws_security_token и access_token устарели и будут удалены в релизе после 2024-12-01.

Поддержка переменных среды EC2_SECRET_KEY и AWS_SECURITY_TOKEN устарела и будет удалена в релизе после 2024-12-01.

streaming_distribution

boolean

Получить информацию о указанном RTMP-дистрибутиве.

Требуется указать distribution_id или domain_name_alias.

Choices:

  • false ← (default)
  • true

streaming_distribution_config

boolean

Получить информацию о конфигурации указанного RTMP-дистрибутива.

Требуется указать distribution_id или domain_name_alias.

Choices:

  • false ← (default)
  • true

summary

boolean

Возвращает краткое описание всех дистрибутивов, потоковых дистрибутивов и origin_access_identities.

Это поведение по умолчанию, если ни один параметр не выбран.

Варианты:

  • false ← (default)
  • true

validate_certs

boolean

При установке в значение false, SSL-сертификаты не будут проверяться при взаимодействии с API AWS.

Установка validate_certs=false настоятельно не рекомендуется. В качестве альтернативы рассмотрите возможность установки aws_ca_bundle.

Варианты:

  • false
  • true ← (default)

Примечания

Примечание

  • Предупреждение: Для модулей переменные среды и конфигурационные файлы считываются из контекста Ansible «хост», а не из контекста «контроллер». Таким образом, файлы могут потребоваться явно скопировать на «хост». Для подключаемых модулей поиска и подключения переменные среды и конфигурационные файлы считываются из контекста Ansible «контроллер», а не из контекста «хост».
  • AWS SDK (boto3), который использует Ansible, также может считывать значения по умолчанию для учетных данных и других параметров, таких как регион, из своих конфигурационных файлов в контексте Ansible «хост» (обычно ~/.aws/credentials). Дополнительную информацию см. в разделе https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html.

Примеры

# Note: These examples do not set authentication details, see the AWS Guide for details.

- name: Get a summary of distributions
  community.aws.cloudfront_distribution_info:
    summary: true
  register: result

- name: Get information about a distribution
  community.aws.cloudfront_distribution_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_distribution_info:
    distribution: true
    domain_name_alias: www.my-website.com
  register: result_website
- ansible.builtin.debug:
    msg: "{{ result_website['cloudfront']['www.my-website.com'] }}"

- name: Get all information about an invalidation for a distribution.
  community.aws.cloudfront_distribution_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_distribution_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_distribution_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_distribution_info:
    all_lists: true

Возвращаемые значения

Общие возвращаемые значения задокументированы здесь, следующие поля уникальны для этого модуля:

Ключ

Описание

distribution

dictionary

Сведения о дистрибутиве CloudFront. Требуется указать distribution_id или domain_name_alias. Требуется установить origin_access_identity_id.

Возвращается: только если distribution имеет значение true

distribution_config

dictionary

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

Возвращается: только если distribution_config имеет значение true

invalidation

dictionary

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

Возвращается: только если invalidation имеет значение true

origin_access_identity

dictionary

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

Возвращается: только если origin_access_identity имеет значение true

origin_access_identity_configuration

dictionary

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

Возвращается: только если origin_access_identity_configuration имеет значение true

result

dictionary

Результат dict не вложен в ID CloudFront для доступа к результатам модуля без знания этого ID, поскольку выяснение DistributionId обычно является причиной использования этого модуля в первую очередь.

Возвращается: всегда

streaming_distribution

dictionary

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

Возвращается: только если streaming_distribution имеет значение true

streaming_distribution_config

dictionary

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

Возвращается: только если streaming_distribution_config имеет значение true

summary

dictionary

Предоставляет краткое описание дистрибутивов, потоковых дистрибутивов и идентификаторов доступа к источнику.

Возвращается: по умолчанию или если summary имеет значение true

Авторы

  • Willem van Ketwich (@wilvk)

Ссылки на коллекцию

  • Система отслеживания ошибок
  • Репозиторий (исходный код)
  • Связь

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/aws/cloudfront_distribution_info_module.html

Spec-Zone.ru

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