Spec-Zone.ru › Ansible 2.6

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
default_action
    Варианты:
  • block
  • allow
  • count
Действие, которое 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
обязательно
Имя Web Application Firewall ACL для управления
profile
(добавлен в 1.6)
Использует профиль 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)
AWS STS security token. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN.

Псевдонимы: access_token
state
    Варианты:
  • present ←
  • absent
указывает, должен ли Web ACL присутствовать или отсутствовать
validate_certs
bool

(добавлен в 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), если учетные данные не предоставлены. См. 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

default_action
dict
всегда
Действие по умолчанию, выполняемое Web ACL, если ни одно правило не совпадает

Пример:
{'type': 'BLOCK'}
metric_name
строка
всегда
Имя метрики, используемое в качестве идентификатора

Пример:
mywebacl
name
строка
всегда
Дружественное имя Web ACL

Пример:
мой веб 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. См. Техническое обслуживание и поддержка модулей для получения дополнительной информации.

Список других модулей, которые также поддерживаются сообществом 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.6/modules/aws_waf_web_acl_module.html

Spec-Zone.ru

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