aws_waf_rule – создание и удаление правил WAF
Новое в версии 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 | |
| conditions - | Список условий, используемых в правиле. Каждое условие должно содержать type: одно из [ byte, geo, ip, size, sql или xss], negated: нужно ли инвертировать условие и condition, имя существующего условия. Можно использовать aws_waf_condition для создания новых условий | |
| debug_botocore_endpoint_logs логический тип добавлен в 2.8 |
| Используйте логирования botocore.endpoint для анализа уникальных (а не общих) API-вызовов «resource:action» во время выполнения задачи, выводя набор в ключ resource_actions результатов задачи. Используйте обратный вызов aws_resource_action для вывода в общий список, составленный во время выполнения книги сценариев. Также можно использовать переменную окружения ANSIBLE_DEBUG_BOTOCORE_LOGS. |
| ec2_url строка | URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех остальных модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если таковая имеется. | |
| metric_name - | Дружественное имя или описание для метрик правила Имя может содержать только буквенно-цифровые символы (A-Z, a-z, 0-9); имя не может содержать пробелы. Вы не можете изменить metric_name после создания правила По умолчанию совпадает с именем, из которого удалены недопустимые символы | |
| name - / обязательно | Имя правила межсетевого экрана веб-приложений | |
| profile строка | Использует профиль boto. Работает только с boto >= 2.24.0. | |
| purge_conditions логический тип |
| Удалить ли условия, которые не пройдены при обновлении `conditions`. |
| region строка | AWS-регион. Если не указан, используется значение переменной окружения AWS_REGION или EC2_REGION, если таковая имеется. См. http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region
псевдонимы: aws_region, ec2_region | |
| security_token строка | AWS STS security token. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. псевдонимы: access_token | |
| state - |
| указать, должно ли правило быть присутствующим или отсутствующим |
| 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 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 | ||
| metric_name строка | всегда | Имя метрики для правила Пример: ansibletest1234rule | ||
| name строка | всегда | Дружественное имя для правила Пример: ansible-test-1234_rule | ||
| predicates сложное | всегда | Список условий, используемых в правиле | ||
| data_id строка | всегда | Идентификатор условия Пример: 8251acdb-526c-42a8-92bc-d3d13e584166 | ||
| negated логический тип | всегда | Определяет, инвертируется ли смысл условия | ||
| type строка | всегда | Тип условия Пример: ByteMatch | ||
| rule_id строка | всегда | Идентификатор правила WAF Пример: 15de0cbc-9204-4e1f-90e6-69b2f415c261 | ||
Статус
- Модуль не гарантирует обратную совместимость интерфейса. [preview]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- Майк Мохан (@mmochan)
- Уилл Теймс (@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_rule_module.html