Spec-Zone.ru › Ansible

community.aws.cloudfront_invalidation модуль — создание аннулирования для распределений AWS CloudFront

Примечание

Этот модуль является частью коллекции community.aws (версия 8.0.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.26.0
  • botocore >= 1.29.0

Параметры

Параметр

Комментарии

access_key

псевдонимы: aws_access_key_id, aws_access_key, ec2_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 или 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.

alias

строка

Псевдоним распределения CloudFront, для которого нужно аннулировать пути. Может быть указан вместо distribution_id.

aws_ca_bundle

путь

Расположение пакета CA для проверки 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 логгер для анализа уникальных (а не общих) "resource:action" API-вызовов, сделанных во время задачи, выводите набор в ключ resource_actions в результатах задачи. Используйте aws_resource_action обратный вызов для вывода в общий список, созданный во время выполнения playbook.

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

Варианты:

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

distribution_id

строка

Идентификатор распределения CloudFront, для которого нужно аннулировать пути. Может быть указан вместо alias.

endpoint_url

псевдонимы: ec2_url, aws_endpoint_url, s3_url

строка

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

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

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

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

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 и security_token.

region

псевдонимы: aws_region, ec2_region

строка

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

псевдонимы: aws_secret_access_key, aws_secret_key, ec2_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, или EC2_SECRET_KEY в порядке убывания приоритета.

Опции secret_key и profile взаимоисключающие.

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

Псевдоним 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 для получения дополнительной информации об access token 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 устарели и будут удалены в релизе после 01.12.2024.

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

target_paths

list / elements=string / required

Список путей на дистрибутиве, которые необходимо сделать недействительными. Каждый путь должен начинаться с /. Разрешены подстановочные знаки. Пример: /foo/bar/*

validate_certs

boolean

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

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

Варианты:

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

Примечания

Примечание

  • не поддерживает режим проверки
  • Внимание: Для модулей переменные среды и конфигурационные файлы считываются из контекста Ansible «хост», а не «контроллер». Следовательно, файлы могут потребоваться скопировать явно на «хост». Для плагинов поиска и подключения переменные среды и конфигурационные файлы считываются из контекста Ansible «контроллер», а не «хост».
  • AWS SDK (boto3), используемый Ansible, также может считывать значения по умолчанию для учетных данных и других настроек, таких как регион, из своих конфигурационных файлов в контексте 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

сложное

Словарь, содержащий информацию об объектах, которые необходимо аннулировать.

Возвращаемое значение: всегда

items

список / элементы=строка

Список путей, которые необходимо аннулировать.

Возвращаемое значение: всегда

Пример: ["/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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/aws/cloudfront_invalidation_module.html

Spec-Zone.ru

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