Модуль community.aws.cloudfront_distribution_info — получение сведений о дистрибутиве AWS CloudFront

Примечание

Этот модуль входит в коллекцию community.aws (версия 10.1.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.34.0
botocore >= 1.34.0

Параметры

Параметр	Комментарии
access_key псевдонимы: aws_access_key_id, aws_access_key строка	Идентификатор ключа доступа 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` в порядке убывания приоритета. Параметры aws_access_key и profile являются взаимоисключающими. Псевдоним aws_access_key_id добавлен в выпуске 5.1.0 для единообразия с AWS botocore SDK.
all_lists логическое значение	Получить все списки CloudFront, для которых не требуются параметры. Варианты: `false` ← (по умолчанию) `true`
aws_ca_bundle путь	Путь к пакету сертификатов ЦС, который следует использовать при проверке SSL-сертификатов. Также можно использовать переменную среды `AWS_CA_BUNDLE`.
aws_config словарь	Словарь для изменения конфигурации botocore. Описание параметров приведено в документации AWS: https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.
debug_botocore_endpoint_logs логическое значение	Использовать регистратор `botocore.endpoint` для обработки уникальных (а не всех) вызовов API `"resource:action"`, выполненных во время задачи, и добавлять их список в ключ resource_actions результатов задачи. Используйте callback `aws_resource_action`, чтобы вывести общий список вызовов, выполненных во время плейбука. Также можно использовать переменную среды `ANSIBLE_DEBUG_BOTOCORE_LOGS`. Варианты: `false` ← (по умолчанию) `true`
distribution логическое значение	Получить сведения о дистрибутиве. Необходимо указать distribution_id или domain_name_alias. Варианты: `false` ← (по умолчанию) `true`
distribution_config логическое значение	Получить сведения о конфигурации дистрибутива. Необходимо указать distribution_id или domain_name_alias. Варианты: `false` ← (по умолчанию) `true`
distribution_id строка	Идентификатор дистрибутива CloudFront. Используется с параметрами distribution, distribution_config, invalidation, streaming_distribution, streaming_distribution_config, list_invalidations.
domain_name_alias строка	Можно использовать вместо distribution_id: для получения идентификатора дистрибутива в нужных случаях используется псевдоним CNAME дистрибутива CloudFront.
endpoint_url псевдонимы: aws_endpoint_url строка	URL-адрес для подключения вместо конечных точек AWS по умолчанию. Хотя этот параметр можно использовать для подключения к другим сервисам, совместимым с AWS, коллекции amazon.aws и community.aws проверяются только с AWS. Также можно использовать переменную среды `AWS_URL`.
invalidation логическое значение	Получить сведения об аннулировании. Необходимо указать invalidation_id. Варианты: `false` ← (по умолчанию) `true`
invalidation_id строка	Идентификатор аннулирования, сведения о котором требуется получить. Используется с параметром invalidation.
list_distributions логическое значение	Получить список дистрибутивов CloudFront. Варианты: `false` ← (по умолчанию) `true`
list_distributions_by_web_acl_id логическое значение	Получить список дистрибутивов, используя идентификатор веб-ACL в качестве фильтра. Необходимо задать web_acl_id. Варианты: `false` ← (по умолчанию) `true`
list_invalidations логическое значение	Получить список аннулирований. Необходимо указать distribution_id или domain_name_alias. Варианты: `false` ← (по умолчанию) `true`
list_origin_access_identities логическое значение	Получить список идентификаторов доступа к источникам CloudFront. Необходимо задать origin_access_identity_id. Варианты: `false` ← (по умолчанию) `true`
list_streaming_distributions логическое значение	Получить список потоковых дистрибутивов. Варианты: `false` ← (по умолчанию) `true`
origin_access_identity логическое значение	Получить сведения об идентификаторе доступа к источнику. Необходимо указать origin_access_identity_id. Варианты: `false` ← (по умолчанию) `true`
origin_access_identity_config логическое значение	Получить сведения о конфигурации идентификатора доступа к источнику. Необходимо указать origin_access_identity_id. Варианты: `false` ← (по умолчанию) `true`
origin_access_identity_id строка	Идентификатор доступа к источнику CloudFront, сведения о котором требуется получить.
profile псевдонимы: aws_profile строка	Именованный профиль AWS для аутентификации. Дополнительные сведения об именованных профилях см. в документации AWS: https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html. Также можно использовать переменную среды `AWS_PROFILE`. Параметр profile взаимоисключающий с параметрами aws_access_key, aws_secret_key и session_token.
region псевдонимы: aws_region строка	Регион AWS, который следует использовать. Для глобальных сервисов, таких как IAM, Route53 и CloudFront, параметр region игнорируется. Также можно использовать переменную среды `AWS_REGION`. Дополнительные сведения см. в документации Amazon AWS: http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region.
secret_key псевдонимы: aws_secret_access_key, aws_secret_key строка	Секретный ключ доступа 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` в порядке убывания приоритета. Параметры secret_key и profile являются взаимоисключающими. Псевдоним aws_secret_access_key добавлен в выпуске 5.1.0 для единообразия с AWS botocore SDK.
session_token псевдонимы: aws_session_token строка	Токен сеанса 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`. Параметры session_token и profile являются взаимоисключающими.
streaming_distribution логическое значение	Получить сведения об указанном дистрибутиве RTMP. Необходимо указать distribution_id или domain_name_alias. Варианты: `false` ← (по умолчанию) `true`
streaming_distribution_config логическое значение	Получить сведения о конфигурации указанного дистрибутива RTMP. Необходимо указать distribution_id или domain_name_alias. Варианты: `false` ← (по умолчанию) `true`
summary логическое значение	Возвращает сводку по всем дистрибутивам, потоковым дистрибутивам и идентификаторам доступа к источникам. Это поведение используется по умолчанию, если не выбран ни один параметр. Варианты: `false` ← (по умолчанию) `true`
validate_certs логическое значение	Если задано значение `false`, SSL-сертификаты при обмене данными с API AWS проверяться не будут. Настоятельно не рекомендуется задавать validate_certs=false; вместо этого рассмотрите возможность использования параметра aws_ca_bundle. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

Внимание: Для модулей переменные среды и файлы конфигурации считываются из контекста Ansible «узла», а не «контроллера». Поэтому файлы может потребоваться явно скопировать на «узел». Для плагинов поиска и подключений переменные среды и файлы конфигурации считываются из контекста Ansible «контроллера», а не «узла».
Используемый Ansible пакет AWS SDK (boto3) также может считывать значения по умолчанию для учетных данных и других параметров, например региона, из файлов конфигурации в контексте 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	Словарь с результатом не вложен в идентификатор CloudFront, чтобы можно было получить результаты работы модуля, не зная этого идентификатора: обычно этот модуль используют именно для определения 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–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/aws/cloudfront_distribution_info_module.html