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 должен выполнить, если запрос не соответствует критериям, заданным в любом из объектов Rule, связанных с 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. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. Псевдонимы: access_token
state -	Варианты: present ← absent	Указывает, должен ли Web ACL существовать или нет.
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 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 словарь		всегда	Действие по умолчанию, выполняемое Web ACL, если ни одно правило не соответствует запросу Пример: {'type': 'BLOCK'}
	metric_name строка		всегда	Имя метрики, используемое в качестве идентификатора Пример: mywebacl
	name строка		всегда	Наглядное имя Web ACL Пример: мой web 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

Статус

Этот модуль не гарантирует обратной совместимости интерфейса. [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.7/modules/aws_waf_web_acl_module.html