community.aws.aws_waf_web_acl – Создание и удаление правил WAF Web ACL.

Примечание

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

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

Чтобы использовать его в книге задач, укажите: community.aws.aws_waf_web_acl.

Введено в версии 1.0.0: of community.aws

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

Обзор

Прочитайте документацию AWS по WAF https://aws.amazon.com/documentation/waf/.

Требования

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

python >= 2.6
boto

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
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
debug_botocore_endpoint_logs логический тип		Варианты: нет ← да	Использовать логгер botocore.endpoint для анализа уникальных (а не общих) API-вызовов "ресурс:действие", осуществленных во время выполнения задачи, выводя набор в ключ resource_actions в результатах задачи. Используйте обратный вызов aws_resource_action для вывода полного списка, созданного во время выполнения книги задач. Переменная среды ANSIBLE_DEBUG_BOTOCORE_LOGS также может быть использована.
default_action строка		Варианты: блокировать разрешить подсчёт	Действие, которое AWS WAF должен выполнить, когда запрос не соответствует критериям, указанным в любом из объектов правила, связанных с WebACL.
ec2_url строка			URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, для которых требуется регион. Должен быть указан для всех других модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если таковая имеется. псевдонимы: aws_endpoint_url, endpoint_url
metric_name строка			Наименование или описание метрик для этого WebACL. Имя может содержать только буквенно-цифровые символы (A-Z, a-z, 0-9); имя не может содержать пробелы. Вы не можете изменить metric_name после создания WebACL. Имя метрики будет по умолчанию совпадать с name, исключая недопустимые символы.
name строка / обязательный параметр			Имя Web Application Firewall ACL для управления.
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
purge_rules логический тип		Варианты: нет ← да	Удалить правила, которые не передаются с параметром rules.
region строка			AWS-регион. Если не указан, используется значение переменной окружения AWS_REGION или EC2_REGION, если таковая имеется. См. http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region псевдонимы: aws_region, ec2_region
rules список / элементы=словарь			Список правил, которые будет применять WebACL.
	action строка / обязательный параметр		Выполняемое действие.
	name строка / обязательный параметр		Имя правила.
	priority целое число / обязательный параметр		Приоритет действия. Приоритеты должны быть уникальными. Правила с более низкими приоритетами обрабатываются в первую очередь.
	type строка	Варианты: rate_based regular	Тип правила.
security_token строка			Токен безопасности AWS STS. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. Если задан параметр profile, этот параметр игнорируется. Передача параметров security_token и profile одновременно устарела и параметры будут сделаны взаимоисключающими после 2022-06-01. псевдонимы: aws_security_token, access_token
state строка		Варианты: present ← absent	Наличие или отсутствие Web ACL.
validate_certs логический тип		Варианты: нет да ←	Если установлено в "нет", SSL-сертификаты не будут проверены для boto-версий >= 2.6.0.
waf_regional логический тип		Варианты: нет ← да	Использовать модуль waf-regional.

Примечания

Примечание

Если параметры не заданы в модуле, могут быть использованы следующие переменные окружения в порядке убывания приоритета 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 web ACL
  community.aws.aws_waf_web_acl:
    name: my_web_acl
    rules:
      - name: my_rule
        priority: 1
        action: block
    default_action: block
    purge_rules: yes
    state: present

- name: delete the web acl
  community.aws.aws_waf_web_acl:
    name: my_web_acl
    state: absent

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

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

Краткое описание полей			Возвращаемое значение	Описание
web_acl сложное			всегда	содержимое Web ACL.
	default_action словарь		всегда	Действие по умолчанию, выполняемое Web ACL, если ни одно из правил не соответствует. Пример: {'type': 'BLOCK'}
	metric_name строка		всегда	Имя метрики, используемое в качестве идентификатора. Пример: mywebacl
	name строка		всегда	Наименование Web ACL. Пример: my web acl
	rules сложное		всегда	Список правил.
		action сложное	всегда	Действие, выполняемое WAF, если правило соответствует. Пример: {'type': 'ALLOW'}
		priority целое число	всегда	Номер приоритета правила (правила с меньшими номерами выполняются первыми). Пример: 2
		rule_id строка	всегда	Идентификатор правила. Пример: a6fc7ab5-287b-479f-8004-7fd0399daf75
		type строка	всегда	Тип правила (REGULAR или RATE_BASED). Пример: REGULAR
	web_acl_id строка		всегда	Уникальный идентификатор Web ACL. Пример: 10fff965-4b6b-46e2-9d78-24f6d2e2d21c

Авторы

Mike Mochan (@mmochan)
Will Thames (@willthames)

© 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/aws_waf_web_acl_module.html