aws_waf_web_acl - создание и удаление правил WAF Web ACL
Новое в версии 2.5.
Обзор
- Прочитайте документацию AWS для WAF https://aws.amazon.com/documentation/waf/
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- python >= 2.6
- boto
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| aws_access_key | По умолчанию: None | Ключ доступа AWS. Если не задан, используется значение переменной окружения AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY. Псевдонимы: ec2_access_key, access_key |
| aws_secret_key | По умолчанию: None | Секретный ключ AWS. Если не задан, используется значение переменной окружения AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY. Псевдонимы: ec2_secret_key, secret_key |
| default_action |
| Действие, которое вы хотите, чтобы AWS WAF выполнял, когда запрос не соответствует критериям, указанным в любом из объектов правила, связанных с WebACL. |
| ec2_url | По умолчанию: None | URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль будет использовать конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех остальных модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если она существует. |
| metric_name | Наименование метрики для данного WebACL Имя может содержать только буквенно-цифровые символы (A-Z, a-z, 0-9); имя не может содержать пробелы. Вы не можете изменить metric_name после создания WebACL Имя метрики будет по умолчанию name с удаленными недопустимыми символами | |
| name обязательно | Имя правила брандмауэра веб-приложений, которое необходимо управлять | |
| profile (добавлено в 1.6) | По умолчанию: None | Использует профиль boto. Работает только с boto >= 2.24.0. |
| purge_rules | Удалить правила, которые не передаются с rules. По умолчанию значение false | |
| 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 (добавлено в 1.6) | По умолчанию: None | AWS STS security token. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. Псевдонимы: access_token |
| state |
| Указывает, должен ли Web ACL быть присутствующим или отсутствующим. |
| validate_certs (добавлено в 1.5) |
| При установке в "no", сертификаты 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), если учетные данные не предоставлены. См. http://boto.readthedocs.org/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 | ||
| rules сложный | всегда | Список правил | ||
| action сложный | всегда | Действие, выполняемое WAF, когда правило совпадает Пример: {'type': 'ALLOW'} | ||
| priority целое число | всегда | номера приоритета правила (правила с меньшими номерами выполняются первыми) Пример: 2 | ||
| type строка | всегда | Тип правила (REGULAR или RATE_BASED) Пример: REGULAR | ||
| rule_id строка | всегда | Идентификатор правила Пример: a6fc7ab5-287b-479f-8004-7fd0399daf75 | ||
| default_action словарь | всегда | Действие по умолчанию Web ACL, если ни одно правило не соответствует Пример: {'type': 'BLOCK'} | ||
| metric_name строка | всегда | Имя метрики, используемое в качестве идентификатора Пример: mywebacl | ||
| name строка | всегда | Наименование Web ACL Пример: my web acl | ||
| 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.5/modules/aws_waf_web_acl_module.html