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 для вывода полного списка, созданного во время выполнения игры.
default_action -	Варианты: блокировать разрешить подсчитать	Действие, которое вы хотите, чтобы AWS WAF выполнял, когда запрос не соответствует критериям, указанным в любом из объектов правила, связанных с WebACL
ec2_url строка		URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль будет использовать конечные точки EC2). Игнорируется для модулей, где регион требуется. Должен быть указан для всех других модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если таковое имеется.
metric_name -		Дружественное имя или описание метрик для этого WebACL Имя может содержать только символы латинского алфавита и цифры (A-Z, a-z, 0-9); имя не может содержать пробелы. Вы не можете изменить metric_name после создания WebACL Имя метрики будет по умолчанию равняться name со удаленными недопустимыми символами
name - / обязательно		Имя правила межсетевого экрана веб-приложений, подлежащего управлению
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 -	Варианты: наличие ← отсутствие	наличие или отсутствие Web ACL
validate_certs логическое значение	Варианты: нет да ←	При установке в «нет», сертификаты SSL не будут проверяться для версий boto >= 2.6.0.
waf_regional логическое значение добавлен в 2.9	Варианты: нет ← да	Использовать модуль waf_regional. По умолчанию — false.

Примечания

Примечание

Если параметры не заданы в модуле, могут использоваться следующие переменные окружения в порядке убывания приоритета 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. [сообщество]

Авторы

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