community.aws.aws_waf_rule – Создание и удаление правил WAF

Примечание

Этот плагин является частью коллекции community.aws (версия 1.3.0).

Для его установки используйте: ansible-galaxy collection install community.aws.

Чтобы использовать его в книге задач, укажите: community.aws.aws_waf_rule.

Новое в версии 1.0.0: of community.aws

Обзор
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

Прочитайте документацию 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. Если задан параметр profile, этот параметр игнорируется. Передача параметров aws_access_key и profile одновременно устарела и параметры будут сделаны взаимоисключающими после 2022-06-01. псевдонимы: ec2_access_key, access_key
aws_ca_bundle путь			Расположение файла с набором сертификатов CA для проверки SSL-сертификатов. Используется только для модулей на основе boto3. Примечание: Набор сертификатов CA считывается со стороны модуля и может потребоваться явное копирование с контроллера, если он не запускается локально.
aws_config словарь			Словарь для изменения конфигурации botocore. Параметры можно найти по адресу https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. Для модулей boto используется только ключ 'user_agent'. См. http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto для более подробной конфигурации boto.
aws_secret_key строка			Секретный ключ AWS. Если не задан, используется значение переменной окружения AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY. Если задан параметр profile, этот параметр игнорируется. Передача параметров aws_secret_key и profile одновременно устарела и параметры будут сделаны взаимоисключающими после 2022-06-01. псевдонимы: ec2_secret_key, secret_key
conditions список / элементы=словарь			Список условий, используемых в правиле. community.aws.aws_waf_condition можно использовать для создания новых условий.
	condition строка / обязательно		Название условия. Условие должно уже существовать.
	negated логическое / обязательно	Варианты: нет да	Указывает, следует ли инвертировать условие.
	type строка / обязательно	Варианты: байт географическое положение ip размер sql xss	Тип правила для соответствия.
debug_botocore_endpoint_logs логическое		Варианты: нет ← да	Использовать логир. botocore.endpoint для анализа уникальных ("ресурс:действие") вызовов API во время задания, выводя список в ключ resource_actions в результатах задания. Используйте callback aws_resource_action для вывода полного списка, сделанного во время книги задач. Переменная окружения ANSIBLE_DEBUG_BOTOCORE_LOGS также может быть использована.
ec2_url строка			URL для подключения к EC2 или облаку Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где регион требуется. Должен быть указан для всех других модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если таковая имеется. псевдонимы: aws_endpoint_url, endpoint_url
metric_name строка			Дружественное имя или описание метрики для правила. Имя может содержать только буквенно-цифровые символы (A-Z, a-z, 0-9); имя не может содержать пробелы. Вы не можете изменить metric_name после создания правила. По умолчанию совпадает с name с удаленными недопустимыми символами.
name строка / обязательно			Имя правила межсетевого экрана веб-приложений.
profile строка			Использует профиль boto. Работает только с boto >= 2.24.0. Использование profile переопределит aws_access_key, aws_secret_key и security_token, и поддержка одновременной передачи их с profile устарела. aws_access_key, aws_secret_key и security_token будут сделаны взаимоисключающими с profile после 2022-06-01. псевдонимы: aws_profile
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. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. Если задан параметр profile, этот параметр игнорируется. Передача параметров security_token и profile одновременно устарела и параметры будут сделаны взаимоисключающими после 2022-06-01. псевдонимы: aws_security_token, access_token
state строка		Варианты: наличие ← отсутствие	Указывает, должно ли правило быть присутствующим или отсутствующим.
validate_certs логическое		Варианты: нет да ←	При установке в "нет", SSL-сертификаты не будут проверяться для версий boto >= 2.6.0.
waf_regional логическое		Варианты: нет ← да	Указывает, использовать ли модуль waf-regional.

Примечания

Примечание

Если параметры не заданы в модуле, могут быть использованы следующие переменные среды в порядке убывания приоритета AWS_URL или EC2_URL, AWS_PROFILE или AWS_DEFAULT_PROFILE, 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, AWS_CA_BUNDLE
Ansible использует файл конфигурации boto (обычно ~/.boto), если данные об учетных записях не предоставлены. См. https://boto.readthedocs.io/en/latest/boto_config_tut.html
AWS_REGION или EC2_REGION обычно используются для указания AWS-региона, когда это необходимо, но это также можно настроить в файле конфигурации boto

Примеры

- name: create WAF rule
  community.aws.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
  community.aws.aws_waf_rule:
    name: "my_waf_rule"
    state: absent

Возвращаемые значения

Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:

Ключ			Возвращаемое значение	Описание
rule complex			всегда	Содержание правила WAF
	metric_name string		всегда	Имя метрики для правила. Пример: ansibletest1234rule
	name string		всегда	Наглядное имя правила. Пример: ansible-test-1234_rule
	predicates complex		всегда	Список условий, используемых в правиле.
		data_id string	всегда	Идентификатор условия. Пример: 8251acdb-526c-42a8-92bc-d3d13e584166
		negated boolean	всегда	Указание, инвертируется ли смысл условия.
		type string	всегда	Тип условия. Пример: ByteMatch
	rule_id string		всегда	Идентификатор правила WAF. Пример: 15de0cbc-9204-4e1f-90e6-69b2f415c261

Авторы

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.10/collections/community/aws/aws_waf_rule_module.html