Модуль community.aws.waf_rule — создание и удаление правил WAF

Примечание

Этот модуль входит в коллекцию community.aws (версия 10.1.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Чтобы установить её, используйте: ansible-galaxy collection install community.aws. Для использования этого модуля требуются дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: community.aws.waf_rule.

Добавлено в community.aws 1.0.0

УСТАРЕЛ
Краткое описание
Требования
Параметры
Примечания
Примеры
Возвращаемые значения
Статус

УСТАРЕЛ

Удалён в:: версии 12.0.0
Причина:: Amazon прекратила поддержку сервиса «WAF Classic».
Альтернатива:: Вместо него используйте сервис и модули «AWS WAF (WAFv2)».

Краткое описание

Ознакомьтесь с документацией AWS по WAF: https://aws.amazon.com/documentation/waf/.
До выпуска 5.0.0 этот модуль назывался community.aws.aws_waf_rule. Способ использования не изменился.

Псевдонимы: aws_waf_rule

Требования

На хосте, выполняющем этот модуль, должны быть установлены следующие компоненты.

python >= 3.6
boto3 >= 1.34.0
botocore >= 1.34.0

Параметры

Параметр	Описание
access_key псевдонимы: aws_access_key_id, aws_access_key строка	Идентификатор ключа доступа AWS. Дополнительные сведения о токенах доступа см. в документации AWS: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также можно использовать переменные окружения `AWS_ACCESS_KEY_ID` или `AWS_ACCESS_KEY` (в порядке убывания приоритета). Параметры aws_access_key и profile являются взаимоисключающими. Псевдоним aws_access_key_id добавлен в выпуске 5.1.0 для согласованности с AWS SDK botocore.
aws_ca_bundle путь	Путь к пакету центров сертификации, используемому для проверки SSL-сертификатов. Также можно использовать переменную окружения `AWS_CA_BUNDLE`.
aws_config словарь	Словарь для изменения конфигурации botocore. Параметры описаны в документации AWS: https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.
conditions список / элементы=словарь	Список условий, используемых в правиле. Для создания условий можно использовать community.aws.waf_condition.
condition строка / обязательный	Название условия. Условие должно существовать заранее.
negated логический / обязательный	Нужно ли инвертировать условие. Варианты: `false` `true`
type строка / обязательный	Тип правила для сопоставления. Варианты: `"byte"` `"geo"` `"ip"` `"size"` `"sql"` `"xss"`
debug_botocore_endpoint_logs логический	Использовать регистратор `botocore.endpoint` для анализа уникальных (а не общего количества) вызовов API `"resource:action"`, выполненных во время задачи, и записывать их список в ключ resource_actions результатов задачи. Используйте обработчик `aws_resource_action`, чтобы вывести общий список вызовов, выполненных в рамках плейбука. Также можно использовать переменную окружения `ANSIBLE_DEBUG_BOTOCORE_LOGS`. Варианты: `false` ← (по умолчанию) `true`
endpoint_url псевдонимы: aws_endpoint_url строка	URL для подключения вместо конечных точек AWS по умолчанию. Его можно использовать для подключения к другим сервисам, совместимым с AWS, однако коллекции amazon.aws и community.aws тестируются только с AWS. Также можно использовать переменную окружения `AWS_URL`.
metric_name строка	Понятное имя или описание метрик правила. Имя может содержать только буквенно-цифровые символы (A-Z, a-z, 0-9); пробелы запрещены. Изменить metric_name после создания правила нельзя. По умолчанию используется значение name с удалёнными недопустимыми символами.
name строка / обязательный	Имя правила межсетевого экрана веб-приложений.
profile псевдонимы: aws_profile строка	Именованный профиль AWS для аутентификации. Дополнительные сведения об именованных профилях см. в документации AWS: https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html. Также можно использовать переменную окружения `AWS_PROFILE`. Параметр profile взаимоисключающий с параметрами aws_access_key, aws_secret_key и session_token.
purge_conditions логический	Удалять ли условия, не переданные при обновлении conditions. Варианты: `false` ← (по умолчанию) `true`
region псевдонимы: aws_region строка	Регион AWS. Для глобальных сервисов, таких как IAM, Route53 и CloudFront, параметр region игнорируется. Также можно использовать переменную окружения `AWS_REGION`. Дополнительные сведения см. в документации Amazon AWS: http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region.
secret_key псевдонимы: aws_secret_access_key, aws_secret_key строка	Секретный ключ доступа AWS. Дополнительные сведения о токенах доступа см. в документации AWS: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также можно использовать переменные окружения `AWS_SECRET_ACCESS_KEY` или `AWS_SECRET_KEY` (в порядке убывания приоритета). Параметры secret_key и profile являются взаимоисключающими. Псевдоним aws_secret_access_key добавлен в выпуске 5.1.0 для согласованности с AWS SDK botocore.
session_token псевдонимы: aws_session_token строка	Токен сеанса AWS STS для использования с временными учётными данными. Дополнительные сведения о токенах доступа см. в документации AWS: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также можно использовать переменную окружения `AWS_SESSION_TOKEN`. Параметры session_token и profile являются взаимоисключающими.
state строка	Должно ли правило присутствовать или отсутствовать. Варианты: `"present"` ← (по умолчанию) `"absent"`
validate_certs логический	Если задано значение `false`, SSL-сертификаты не будут проверяться при обмене данными с API AWS. Настоятельно не рекомендуется задавать validate_certs=false; вместо этого рассмотрите возможность использования параметра aws_ca_bundle. Варианты: `false` `true` ← (по умолчанию)
waf_regional логический	Использовать ли модуль `waf-regional`. Варианты: `false` ← (по умолчанию) `true`

Примечания

Примечание

Внимание: Для модулей переменные окружения и файлы конфигурации считываются в контексте «хоста» Ansible, а не «контроллера». Поэтому может потребоваться явно скопировать файлы на «хост». Для плагинов поиска и подключений переменные окружения и файлы конфигурации считываются в контексте «контроллера» Ansible, а не «хоста».
Используемый Ansible AWS SDK (boto3) также может считывать значения по умолчанию для учётных данных и других параметров, например региона, из файлов конфигурации в контексте «хоста» Ansible (обычно ~/.aws/credentials). Дополнительные сведения см. на странице https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html.

Примеры

- name: create WAF rule
  community.aws.waf_rule:
    name: my_waf_rule
    conditions:
      - name: my_regex_condition
        type: regex
        negated: false
      - name: my_geo_condition
        type: geo
        negated: false
      - name: my_byte_condition
        type: byte
        negated: true

- name: remove WAF rule
  community.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 логический	Инвертировано ли условие. Возвращается: всегда Пример: `false`
type строка	Тип условия. Возвращается: всегда Пример: `"ByteMatch"`
rule_id строка	Идентификатор правила WAF. Возвращается: всегда Пример: `"15de0cbc-9204-4e1f-90e6-69b2f415c261"`

Статус

Этот модуль будет удалён в версии 12.0.0. [устарел]
Дополнительные сведения см. в разделе УСТАРЕЛ.

Авторы

Mike Mochan (@mmochan)
Will Thames (@willthames)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/aws/waf_rule_module.html