Модуль community.aws.waf_rule — Создание и удаление правил WAF
Примечание
Этот модуль входит в коллекцию community.aws (версия 8.0.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install community.aws. Для использования этого модуля требуются дополнительные зависимости, см. Требования для подробностей.
Для использования в playbook укажите: community.aws.waf_rule.
Новая в community.aws 1.0.0
Описание
- Прочитайте документацию AWS для WAF https://aws.amazon.com/documentation/waf/.
- До версии 5.0.0 этот модуль назывался
community.aws.aws_waf_rule. Использование не изменилось.
Псевдонимы: aws_waf_rule
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- python >= 3.6
- boto3 >= 1.26.0
- botocore >= 1.29.0
Параметры
Параметр | Комментарии |
|---|---|
access_key псевдонимы: aws_access_key_id, aws_access_key, ec2_access_key строка | Идентификатор ключа доступа AWS. См. документацию AWS для получения дополнительной информации об access токенах https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также могут быть использованы переменные окружения Параметры aws_access_key и profile взаимоисключающие. Псевдоним aws_access_key_id был добавлен в релизе 5.1.0 для согласованности с SDK AWS botocore. Псевдоним ec2_access_key устарел и будет удален в релизе после 2024-12-01. Поддержка переменной окружения |
aws_ca_bundle путь | Расположение пакета CA для проверки SSL-сертификатов. Также может быть использована переменная окружения |
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 булево / обязательно |
Должно ли условие быть инвертировано. Варианты:
|
|
type строка / обязательно |
Тип правила для сопоставления. Варианты:
|
debug_botocore_endpoint_logs булево | Использовать логгер Также может быть использована переменная окружения Варианты:
|
endpoint_url псевдонимы: ec2_url, aws_endpoint_url, s3_url строка | URL для подключения вместо стандартных AWS-endpoinтов. Хотя это можно использовать для подключения к другим совместимым с AWS сервисам, коллекции amazon.aws и community.aws протестированы только против AWS. Также могут быть использованы переменные окружения Псевдонимы ec2_url и s3_url устарели и будут удалены в релизе после 2024-12-01. Поддержка переменной окружения |
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. Также может быть использована переменная окружения Параметр profile взаимоисключает параметры aws_access_key, aws_secret_key и security_token. |
purge_conditions булево | Удалять ли условия, которые не пройдены при обновлении conditions. Варианты:
|
region псевдонимы: aws_region, ec2_region строка | AWS регион для использования. Для глобальных сервисов, таких как IAM, Route53 и CloudFront, region игнорируется. Также могут быть использованы переменные окружения См. документацию Amazon AWS для получения дополнительной информации http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region. Псевдоним Поддержка переменной окружения |
secret_key aliases: aws_secret_access_key, aws_secret_key, ec2_secret_key string | Секретный ключ доступа AWS. См. документацию AWS для получения дополнительной информации о маркерах доступа https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также можно использовать переменные среды Параметры secret_key и profile взаимоисключают друг друга. Псевдоним aws_secret_access_key был добавлен в релизе 5.1.0 для согласованности с SDK AWS botocore. Псевдоним ec2_secret_key устарел и будет удален в релизе после 2024-12-01. Поддержка переменной среды |
session_token aliases: aws_session_token, security_token, aws_security_token, access_token string | Токен сеанса AWS STS для использования с временными учетными данными. См. документацию AWS для получения дополнительной информации о маркерах доступа https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также можно использовать переменные среды Параметры 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. Поддержка переменных среды |
state string | Определяет, должна ли правило существовать или отсутствовать. Варианты:
|
validate_certs boolean | При установке в Установка validate_certs=false настоятельно не рекомендуется; в качестве альтернативы, установите aws_ca_bundle. Варианты:
|
waf_regional boolean | Использовать модуль Варианты:
|
Примечания
Примечание
- Внимание: Для модулей переменные среды и конфигурационные файлы считываются из контекста хоста Ansible, а не контекста контроллера. Поэтому файлы могут потребоваться явно скопировать на хост. Для плагинов поиска и соединения переменные среды и конфигурационные файлы считываются из контекста контроллера Ansible, а не контекста хоста.
- AWS SDK (boto3), используемый Ansible, также может считывать значения по умолчанию для учетных данных и других настроек, таких как регион, из своих конфигурационных файлов в контексте хоста 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 строка |
Имя метрики для правила. Возвращается: всегда Пример: |
|
name строка |
Наименование правила для удобства. Возвращается: всегда Пример: |
|
predicates сложный |
Список условий, используемых в правиле. Возвращается: всегда |
|
data_id строка |
Идентификатор условия. Возвращается: всегда Пример: |
|
negated булево |
Указывается, инвертируется ли смысл условия. Возвращается: всегда Пример: |
|
type строка |
тип условия. Возвращается: всегда Пример: |
|
rule_id строка |
Идентификатор правила WAF. Возвращается: всегда Пример: |
Ссылки на коллекции
© 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_rule_module.html