community.aws.cloudfront_invalidation – создание недействительных данных для распределений AWS CloudFront

Примечание

Этот плагин является частью коллекции community.aws (версия 1.3.0).

Для его установки используйте: ansible-galaxy collection install community.aws.

Для использования в книге задач, укажите: community.aws.cloudfront_invalidation.

Новое в версии 1.0.0: из community.aws

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

Описание

Разрешает аннулирование набора путей для распределения CloudFront.

Требования

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

boto
boto3 >= 1.0.0
python >= 2.6

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
alias строка		Псевдоним распределения CloudFront, для которого нужно аннулировать пути. Может быть указан вместо distribution_id.
aws_access_key строка		Ключ доступа AWS. Если не задан, используется значение переменной среды AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY. Если задан параметр profile, этот параметр игнорируется. Одновременное использование параметров aws_access_key и profile устарело и эти параметры будут сделаны взаимоисключающими после 2022-06-01. псевдонимы: ec2_access_key, access_key
aws_ca_bundle путь		Расположение файла с корневыми сертификатами CA для проверки SSL-сертификатов. Используется только для модулей, основанных на boto3. Примечание: Файл CA Bundle читается со стороны модуля и, возможно, требует явного копирования с контроллера, если он не выполняется локально.
aws_config словарь		Словарь для изменения конфигурации botocore. Параметры можно найти по адресу https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. Для модулей boto используется только ключ 'user_agent'. См. http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto для дополнительной конфигурации boto.
aws_secret_key строка		Секретный ключ AWS. Если не задан, используется значение переменной среды AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY. Если задан параметр profile, этот параметр игнорируется. Одновременное использование параметров aws_secret_key и profile устарело и эти параметры будут сделаны взаимоисключающими после 2022-06-01. псевдонимы: ec2_secret_key, secret_key
caller_reference строка		Уникальный идентификатор запроса для путей аннулирования. По умолчанию устанавливается текущая метка времени.
debug_botocore_endpoint_logs логический	Варианты: нет ← да	Используйте логирование botocore.endpoint для анализа уникальных (а не общих) API-вызовов «ресурс:действие», выполненных во время задачи, выводя набор в ключ resource_actions результатов задачи. Используйте обратный вызов aws_resource_action для вывода в общий список, созданный во время книги задач. Также может использоваться переменная среды ANSIBLE_DEBUG_BOTOCORE_LOGS.
distribution_id строка		Идентификатор распределения CloudFront, для которого нужно аннулировать пути. Может быть указан вместо псевдонима.
ec2_url строка		URL для подключения к облаку EC2 или Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех других модулей, если регион не используется. Если не задан, используется значение переменной среды EC2_URL, если таковая имеется. псевдонимы: aws_endpoint_url, endpoint_url
profile строка		Использует профиль boto. Работает только с boto >= 2.24.0. Использование profile переопределяет aws_access_key, aws_secret_key и security_token, а поддержка их одновременного указания с profile устарела. aws_access_key, aws_secret_key и security_token станут взаимоисключающими с profile после 2022-06-01. псевдонимы: aws_profile
region строка		AWS регион для использования. Если не указан, используется значение переменной среды AWS_REGION или EC2_REGION, если таковая имеется. См. http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region псевдонимы: aws_region, ec2_region
security_token строка		AWS STS security token. Если не задан, используется значение переменной среды AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. Если задан параметр profile, этот параметр игнорируется. Одновременное использование параметров security_token и profile устарело и эти параметры будут сделаны взаимоисключающими после 2022-06-01. псевдонимы: aws_security_token, access_token
target_paths список / элементы=строка / обязательно		Список путей на дистрибутиве для аннулирования. Каждый путь должен начинаться с '/'. Разрешены подстановочные знаки. Пример: '/foo/bar/*'
validate_certs логический	Варианты: нет да ←	При установке в «нет», SSL-сертификаты не будут проверяться для версий boto >= 2.6.0.

Примечания

Примечание

не поддерживает режим проверки
Если параметры не заданы в модуле, можно использовать следующие переменные среды в порядке убывания приоритета AWS_URL или EC2_URL, AWS_PROFILE или AWS_DEFAULT_PROFILE, 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, AWS_CA_BUNDLE
Ansible использует файл конфигурации boto (обычно ~/.boto), если учетные данные не предоставлены. См. https://boto.readthedocs.io/en/latest/boto_config_tut.html
AWS_REGION или EC2_REGION можно использовать для указания AWS региона, когда это необходимо, но это также можно настроить в файле конфигурации boto

Примеры

- 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 complex				всегда	Информация о недействительности.
	create_time string			всегда	Дата и время первого запроса на недействительность. Пример: 2018-02-01T15:50:41.159000+00:00
	id string			всегда	Идентификатор запроса на недействительность. Пример: I2G9MOWJZFV612
	invalidation_batch complex			всегда	Текущая информация о недействительности для запроса на пакетную обработку.
		caller_reference string		всегда	Значение, используемое для уникальной идентификации запроса на недействительность. Пример: testing 123
		paths complex		всегда	Словарь, содержащий информацию об объектах, которые требуется сделать недействительными.
			items list / elements=string	всегда	Список путей, которые требуется сделать недействительными. Пример: ['/testpathtwo/test2.js', '/testpathone/test1.css', '/testpaththree/test3.ss']
			quantity integer	всегда	Количество объектов, которые требуется сделать недействительными. Пример: 3
	status string			всегда	Статус запроса на недействительность. Пример: Завершено
location string				всегда	Полностью квалифицированный URI распределения и запроса на пакетную недействительность. Пример: https://cloudfront.amazonaws.com/2017-03-25/distribution/E1ZID6KZJECZY7/invalidation/I2G9MOWJZFV622

Авторы

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.10/collections/community/aws/cloudfront_invalidation_module.html