aws_waf_web_acl – создание и удаление правил WAF Web ACL

Новая версия с 2.5.

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

Краткий обзор

Прочитайте документацию 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. псевдонимы: ec2_access_key, access_key
aws_secret_key строка		Секретный ключ AWS. Если не задан, используется значение переменной окружения AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY. псевдонимы: ec2_secret_key, secret_key
debug_botocore_endpoint_logs булево добавлено в 2.8	Варианты: нет ← да	Использование логгера 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, если таковое имеется.
metric_name -		Наименование метрики для данного WebACL Имя может содержать только буквенно-цифровые символы (A-Z, a-z, 0-9); имя не может содержать пробелы. Имя метрики нельзя изменить после создания WebACL. Имя метрики по умолчанию имя с удаленными недопустимыми символами
name - / обязательно		Имя правила Web Application Firewall ACL для управления
profile строка		Использование профиля boto. Работает только с boto >= 2.24.0.
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 -		Список правил, которые будет применять Web ACL. Каждое правило должно содержать ключи name, action, priority. Приоритеты должны быть уникальными, но не обязательно последовательными. Правила с меньшими номерами приоритетов обрабатываются первыми. Ключ type может быть передан как `rate_based`, по умолчанию `regular`.
security_token строка		Токен безопасности AWS STS. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. псевдонимы: access_token
state -	Варианты: present ← absent	Определяет, должен ли Web ACL быть присутствующим или отсутствовать
validate_certs булево	Варианты: нет да ←	При значении "нет" сертификаты SSL не будут проверены для версий boto >= 2.6.0.

Примечания

Примечание

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

Примеры

- name: create web ACL
  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
  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

Статус

Данный модуль не гарантирует обратную совместимость. [превью]
Этот модуль поддерживается сообществом Ansible. [community]

Авторы

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