Spec-Zone.ru › Ansible 2.7

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 можно использовать для создания новых условий.
ec2_url
-
URL для подключения к EC2 или облаку Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех остальных модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если она есть.
metric_name
-
Наименование метрики для правила, которое понятно и описывает метрику.
Имя может содержать только буквенно-цифровые символы (A-Z, a-z, 0-9), но не может содержать пробелы.
Имя метрики нельзя изменить после создания правила.
По умолчанию совпадает с именем правила, из которого удалены недопустимые символы.
name
- / обязательно
Имя правила межсетевого экрана веб-приложений (WAF).
profile
-
добавлено в 1.6
Использует профиль 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
Токен безопасности AWS STS. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN.

Псевдонимы: access_token
state
-
    Варианты:
  • present ←
  • absent
Указывает, должно ли правило существовать или отсутствовать.
validate_certs
boolean
добавлено в 1.5
    Варианты:
  • no
  • yes ←
Если установлено в "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), если данные об учетных записях не предоставлены. См. 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
boolean
всегда
Указывает, инвертируется ли смысл условия

type
строка
всегда
Тип условия

Пример:
ByteMatch
rule_id
строка
всегда
Идентификатор правила WAF

Пример:
15de0cbc-9204-4e1f-90e6-69b2f415c261


Статус

  • Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
  • Этот модуль поддерживается сообществом 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.7/modules/aws_waf_rule_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API