aws_waf_rule - создание и удаление правил WAF
Новое в версии 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 |
| conditions | Список условий, используемых в правиле. Каждое условие должно содержать type: одно из [ byte, geo, ip, size, sql или xss] negated: нужно ли инвертировать условие, и condition, имя существующего условия. aws_waf_condition можно использовать для создания новых условий | |
| ec2_url | Значение по умолчанию: None | URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех остальных модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если она существует. |
| metric_name | Дружественное имя или описание метрик для правила. Имя может содержать только буквенно-цифровые символы (A-Z, a-z, 0-9); имя не может содержать пробелы. Вы не можете изменить metric_name после создания правила. По умолчанию совпадает с именем, из которого удалены недопустимые символы. | |
| name обязательно | Имя правила межсетевого экрана веб-приложений | |
| profile (добавлен в 1.6) | Значение по умолчанию: None | Использует профиль boto. Работает только с boto >= 2.24.0. |
| purge_conditions | Удалить условия, не удовлетворяющие требованиям при обновлении `conditions`. По умолчанию false. | |
| region | Регион AWS для использования. Если не указан, используется значение переменной окружения AWS_REGION или EC2_REGION, если она существует. См. http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region
Псевдонимы: aws_region, ec2_region | |
| security_token (добавлен в 1.6) | Значение по умолчанию: None | Токен безопасности AWS STS. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. Псевдонимы: access_token |
| state |
| указывает, должно ли правило быть присутствующим или отсутствующим |
| 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 WAF rule
aws_waf_rule:
name: my_waf_rule
conditions:
- name: my_regex_condition
type: regex
negated: no
- name: my_geo_condition
type: geo
negated: no
- name: my_byte_condition
type: byte
negated: yes
- name: remove WAF rule
aws_waf_rule:
name: "my_waf_rule"
state: absent
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание | ||
|---|---|---|---|---|
| rule сложное | всегда | Содержимое правила WAF | ||
| predicates сложное | всегда | Список условий, используемых в правиле | ||
| negated bool | всегда | Указывает, инвертировано ли условие | ||
| type строка | всегда | Тип условия Пример: ByteMatch | ||
| data_id строка | всегда | Идентификатор условия Пример: 8251acdb-526c-42a8-92bc-d3d13e584166 | ||
| rule_id строка | всегда | Идентификатор правила WAF Пример: 15de0cbc-9204-4e1f-90e6-69b2f415c261 | ||
| name строка | всегда | Дружественное имя правила Пример: ansible-test-1234_rule | ||
| metric_name строка | всегда | Имя метрики для правила Пример: ansibletest1234rule | ||
Статус
Этот модуль помечен как предварительный, что означает, что его интерфейс не гарантирует обратной совместимости.
Автор
- 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_rule_module.html