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:action" во время задачи, выводя набор в ключ 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 токен безопасности. Если не задан, используется значение переменной среды 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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/aws/cloudfront_invalidation_module.html