Модуль community.aws.cloudfront_invalidation — создание инвалидаций для дистрибутивов AWS CloudFront

Примечание

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

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

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

Чтобы использовать модуль в плейбуке, укажите: community.aws.cloudfront_invalidation.

Добавлено в community.aws 1.0.0

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

Краткое описание

Позволяет аннулировать пакет путей для дистрибутива CloudFront.

Требования

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

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.
alias строка	Псевдоним дистрибутива CloudFront, для которого нужно аннулировать пути. Можно указать вместо distribution_id.
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.
caller_reference строка	Уникальный идентификатор-ссылка для путей инвалидации. По умолчанию используется текущая дата и время.
debug_botocore_endpoint_logs логическое значение	Использовать регистратор `botocore.endpoint` для анализа уникальных (а не общего количества) вызовов API `"resource:action"`, выполненных во время задачи, и выводить их список в ключ resource_actions результатов задачи. Используйте обработчик обратного вызова `aws_resource_action`, чтобы вывести общий список вызовов, выполненных во время плейбука. Также можно использовать переменную окружения `ANSIBLE_DEBUG_BOTOCORE_LOGS`. Варианты: `false` ← (по умолчанию) `true`
distribution_id строка	Идентификатор дистрибутива CloudFront, для которого нужно аннулировать пути. Можно указать вместо alias.
endpoint_url псевдонимы: aws_endpoint_url строка	URL для подключения вместо конечных точек AWS по умолчанию. Хотя этот параметр можно использовать для подключения к другим совместимым с AWS сервисам, коллекции amazon.aws и community.aws тестируются только с AWS. Также можно использовать переменную окружения `AWS_URL`.
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 являются взаимоисключающими.
target_paths список / элементы=строка / обязательный	Список путей в дистрибутиве, которые нужно аннулировать. Каждый путь должен начинаться с `/`. Допускаются подстановочные знаки. Например: `/foo/bar/*`
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.

Примеры

- name: create a batch of invalidations using a distribution_id for a reference
  community.aws.cloudfront_invalidation:
    distribution_id: E15BU8SDCGSG57
    caller_reference: testing 123
    target_paths:
      - /testpathone/test1.css
      - /testpathtwo/test2.js
      - /testpaththree/test3.ss

- name: create a batch of invalidations using an alias as a reference and one path using a wildcard match
  community.aws.cloudfront_invalidation:
    alias: alias.test.com
    caller_reference: testing 123
    target_paths:
      - /testpathone/test4.css
      - /testpathtwo/test5.js
      - /testpaththree/*

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

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

Ключ	Описание
invalidation сложный тип	Информация об инвалидации. Возвращается: всегда
create_time строка	Дата и время, когда впервые был отправлен запрос на инвалидацию. Возвращается: всегда Пример: `"2018-02-01T15:50:41.159000+00:00"`
id строка	Идентификатор запроса на инвалидацию. Возвращается: всегда Пример: `"I2G9MOWJZFV612"`
invalidation_batch сложный тип	Текущая информация об инвалидации для пакетного запроса. Возвращается: всегда
caller_reference строка	Значение, используемое для уникальной идентификации запроса на инвалидацию. Возвращается: всегда Пример: `"testing 123"`
paths сложный тип	Словарь с информацией об объектах, которые нужно аннулировать. Возвращается: всегда
elements список / элементы=строка добавлено в community.aws 10.1.0	Список путей, которые нужно аннулировать. Возвращается: всегда Пример: `["/testpathtwo/test2.js", "/testpathone/test1.css", "/testpaththree/test3.ss"]`
items список / элементы=строка	Список путей, которые нужно аннулировать. Это возвращаемое значение устарело и будет удалено в одном из выпусков после 2026-12-16. Вместо него используйте `invalidation.invalidation_batch.paths.elements`. Возвращается: всегда Пример: `["/testpathtwo/test2.js", "/testpathone/test1.css", "/testpaththree/test3.ss"]`
quantity целое число	Количество объектов, которые нужно аннулировать. Возвращается: всегда Пример: `3`
status строка	Статус запроса на инвалидацию. Возвращается: всегда Пример: `"Completed"`
location строка	Полный URI дистрибутива и пакетного запроса на инвалидацию. Возвращается: всегда Пример: `"https://cloudfront.amazonaws.com/2017-03-25/distribution/E1ZID6KZJECZY7/invalidation/I2G9MOWJZFV622"`

Авторы

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_invalidation_module.html