Модуль community.aws.waf_web_acl — создание и удаление списков управления доступом WAF

Примечание

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

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

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

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

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

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

УСТАРЕЛО

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

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

Модуль для WAF Classic; для 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.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 путь	Путь к пакету сертификатов 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` для анализа уникальных (а не общего количества) вызовов API `"resource:action"`, выполняемых во время задачи, и выводить полученный набор в ключ resource_actions результатов задачи. Используйте обработчик обратного вызова `aws_resource_action`, чтобы вывести общий список вызовов, выполненных в ходе плейбука. Также можно использовать переменную среды `ANSIBLE_DEBUG_BOTOCORE_LOGS`. Варианты: `false` ← (по умолчанию) `true`
default_action строка	Действие, которое AWS WAF должен выполнить, если запрос не соответствует критериям ни одного из объектов Rule, связанных с WebACL. Варианты: `"block"` `"allow"` `"count"`
endpoint_url псевдонимы: aws_endpoint_url строка	URL-адрес для подключения вместо конечных точек AWS по умолчанию. Хотя этот параметр можно использовать для подключения к другим сервисам, совместимым с AWS, коллекции amazon.aws и community.aws тестируются только с AWS. Также можно использовать переменную среды `AWS_URL`.
metric_name строка	Удобное имя или описание метрик для этого WebACL. Имя может содержать только буквенно-цифровые символы (A-Z, a-z, 0-9); пробелы в имени недопустимы. Изменить metric_name после создания WebACL нельзя. По умолчанию для имени метрики используется значение 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_rules логическое значение	Удалять ли правила, не переданные в параметре rules. Варианты: `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.
rules список / элементы=словарь	Список правил, применяемых списком управления доступом Web ACL.
action строка / обязательный	Выполняемое действие.
name строка / обязательный	Имя правила.
priority целое число / обязательный	Приоритет действия. Приоритеты должны быть уникальными. Сначала проверяются правила с меньшим номером приоритета.
type строка	Тип правила. Варианты: `"rate_based"` `"regular"`
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 строка	Должен ли список управления доступом 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, а не «контроллера». Поэтому файлы, возможно, потребуется явно скопировать на «узел». Для плагинов поиска и подключения переменные среды и файлы конфигурации считываются в контексте «контроллера» Ansible, а не «узла».
Используемый Ansible AWS SDK (boto3) также может считывать значения по умолчанию для учётных данных и других настроек, например региона, из файлов конфигурации в контексте «узла» Ansible (обычно ~/.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 сложный тип	Содержимое Web ACL. Возвращается: всегда
default_action словарь	Действие по умолчанию, выполняемое Web ACL, если ни одно правило не сработало. Возвращается: всегда Пример: `{"type": "BLOCK"}`
metric_name строка	Имя метрики, используемое в качестве идентификатора. Возвращается: всегда Пример: `"mywebacl"`
name строка	Удобное имя Web 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 строка	Уникальный идентификатор Web ACL. Возвращается: всегда Пример: `"10fff965-4b6b-46e2-9d78-24f6d2e2d21c"`

Статус

Этот модуль будет удалён в версии 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_web_acl_module.html