Модуль community.aws.waf_web_acl — Создание и удаление правил WAF Web ACL

Примечание

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

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

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

Для использования в книге задач укажите: community.aws.waf_web_acl.

Введено в community.aws 1.0.0

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

Описание

Модуль для классического WAF, для WAF v2 используйте модули wafv2_*.
Прочитайте документацию AWS для WAF по адресу https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html.
До версии 5.0.0 этот модуль назывался community.aws.aws_waf_web_acl. Способ использования не изменился.

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

Требования

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

python >= 3.6
boto3 >= 1.26.0
botocore >= 1.29.0

END_OF_DOCUMENT_MARKER

Параметры

Параметр	Комментарии
access_key псевдонимы: aws_access_key_id, aws_access_key, ec2_access_key строка	ID ключа доступа 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` или `EC2_ACCESS_KEY` в порядке убывания приоритета. Параметры aws_access_key и profile взаимоисключающие. Псевдоним aws_access_key_id был добавлен в релизе 5.1.0 для соответствия SDK AWS botocore. Псевдоним ec2_access_key устарел и будет удален в релизе после 2024-12-01. Поддержка переменной среды `EC2_ACCESS_KEY` устарела и будет удалена в релизе после 2024-12-01.
aws_ca_bundle путь	Расположение набора сертификатов CA для проверки SSL-сертификатов. Также может быть использована переменная среды `AWS_CA_BUNDLE`.
aws_config словарь	Словарь для модификации конфигурации botocore. Параметры можно найти в документации AWS https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.
debug_botocore_endpoint_logs логический тип	Использовать логгер `botocore.endpoint` для анализа уникальных (а не общих) `"resource:action"` вызовов API во время задачи, выводя набор в ключ resource_actions в результатах задачи. Используйте обратный вызов `aws_resource_action` для вывода общего списка, выполненного во время выполнения книги сценариев. Также может быть использована переменная среды `ANSIBLE_DEBUG_BOTOCORE_LOGS`. Варианты: `false` ← (по умолчанию) `true`
default_action строка	Действие, которое вы хотите, чтобы AWS WAF выполнял, когда запрос не соответствует критериям, указанным в любом из объектов Rule, связанных с WebACL. Варианты: `"block"` `"allow"` `"count"`
endpoint_url псевдонимы: ec2_url, aws_endpoint_url, s3_url строка	URL для подключения вместо стандартных конечных точек AWS. Хотя это можно использовать для подключения к другим службам, совместимым с AWS, коллекции amazon.aws и community.aws протестированы только с AWS. Также могут использоваться переменные среды `AWS_URL` или `EC2_URL` в порядке убывания приоритета. Псевдонимы ec2_url и s3_url устарели и будут удалены в релизе после 2024-12-01. Поддержка переменной среды `EC2_URL` устарела и будет удалена в релизе после 2024-12-01.
metric_name строка	Наглядное имя или описание метрик для данного WebACL. Имя может содержать только буквенно-цифровые символы (A-Z, a-z, 0-9); имя не может содержать пробелы. Имя метрики metric_name нельзя изменить после создания WebACL. Имя метрики по умолчанию — name с удаленными недопустимыми символами.
name строка / обязательный	Имя Web Application Firewall ACL для управления.
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 и security_token.
purge_rules логический тип	Удалить правила, которые не передаются с параметром rules. Варианты: `false` ← (по умолчанию) `true`
region псевдонимы: aws_region, ec2_region строка	AWS регион для использования. Для глобальных сервисов, таких как IAM, Route53 и CloudFront, region игнорируется. Также могут использоваться переменные среды `AWS_REGION` или `EC2_REGION`. См. документацию Amazon AWS для получения дополнительной информации http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region. Псевдоним `ec2_region` устарел и будет удален в релизе после 2024-12-01. Поддержка переменной среды `EC2_REGION` устарела и будет удалена в релизе после 2024-12-01.
rules список / элементы=словарь	Список правил, которые будет применять Web ACL.
action строка / обязательный	Действие для выполнения.
name строка / обязательный	Имя правила.
priority целое число / обязательный	Приоритет действия. Приоритеты должны быть уникальными. Правила с меньшими номерами приоритетов обрабатываются первыми.

type string	Тип правила. Варианты: `"rate_based"` `"regular"`
secret_key псевдонимы: aws_secret_access_key, aws_secret_key, ec2_secret_key строка	Секретный ключ доступа к AWS. См. документацию AWS для получения дополнительной информации об access token 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`, или `EC2_SECRET_KEY` в порядке убывания приоритета. Параметры secret_key и profile взаимоисключающие. Псевдоним aws_secret_access_key добавлен в релизе 5.1.0 для согласованности с AWS botocore SDK. Псевдоним ec2_secret_key устарел и будет удален в релизе после 2024-12-01. Поддержка переменной среды `EC2_SECRET_KEY` устарела и будет удалена в релизе после 2024-12-01.
session_token псевдонимы: aws_session_token, security_token, aws_security_token, access_token строка	AWS STS сессия token для использования с временными учетными данными. См. документацию AWS для получения дополнительной информации об access token https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также можно использовать переменные среды `AWS_SESSION_TOKEN`, `AWS_SECURITY_TOKEN` или `EC2_SECURITY_TOKEN` в порядке убывания приоритета. Параметры security_token и profile взаимоисключающие. Псевдонимы aws_session_token и session_token добавлены в релизе 3.2.0, с переименованием параметра с security_token на session_token в релизе 6.0.0. Псевдонимы security_token, aws_security_token и access_token устарели и будут удалены в релизе после 2024-12-01. Поддержка переменных среды `EC2_SECRET_KEY` и `AWS_SECURITY_TOKEN` устарела и будет удалена в релизе после 2024-12-01.
state строка	Указывает, должен ли Web ACL существовать или отсутствовать. Варианты: `"present"` ← (по умолчанию) `"absent"`
validate_certs булево	При установке в `false`, сертификаты SSL для связи с API AWS не будут проверяться. Установка validate_certs=false крайне не рекомендуется. В качестве альтернативы, рассмотрите настройку aws_ca_bundle. Варианты: `false` `true` ← (по умолчанию)
waf_regional булево	Указывает, использовать ли модуль `waf-regional`. Варианты: `false` ← (по умолчанию) `true`

Примечания

Примечание

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

Примеры

- name: create web ACL
  community.aws.waf_web_acl:
    name: my_web_acl
    rules:
      - name: my_rule
        priority: 1
        action: block
    default_action: block
    purge_rules: true
    state: present

- name: delete the web acl
  community.aws.waf_web_acl:
    name: my_web_acl
    state: absent

Значения возврата

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

Ключ	Описание
web_acl сложное	содержимое Веб-ACL. Возвращается: всегда
default_action словарь	Действие по умолчанию, выполняемое Веб-ACL, если ни одно правило не соответствует. Возвращается: всегда Пример: `{"type": "BLOCK"}`
metric_name строка	Имя метрики, используемое в качестве идентификатора. Возвращается: всегда Пример: `"mywebacl"`
name строка	Наименование Веб-ACL. Возвращается: всегда Пример: `"my web acl"`
rules сложное	Список правил. Возвращается: всегда
action сложное	Действие, выполняемое WAF, когда правило совпадает. Возвращается: всегда Пример: `{"type": "ALLOW"}`
priority целое число	Номер приоритета правила (правила с меньшими номерами выполняются первыми). Возвращается: всегда Пример: `2`
rule_id строка	Идентификатор правила. Возвращается: всегда Пример: `"a6fc7ab5-287b-479f-8004-7fd0399daf75"`
type строка	Тип правила (REGULAR или RATE_BASED). Возвращается: всегда Пример: `"REGULAR"`
web_acl_id строка	Уникальный идентификатор Веб-ACL. Возвращается: всегда Пример: `"10fff965-4b6b-46e2-9d78-24f6d2e2d21c"`

Авторы

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

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

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