community.aws.wafv2_rule_group модуль – wafv2_web_acl

Примечание

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

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

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

Чтобы использовать его в playbook, укажите: community.aws.wafv2_rule_group.

Новая версия в community.aws 1.5.0

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

Описание

Создание, изменение и удаление групп правил wafv2.

Требования

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

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

Параметры

Параметр	Комментарии
access_key aliases: aws_access_key_id, aws_access_key, ec2_access_key string	Идентификатор ключа доступа 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 для согласованности с AWS botocore SDK. Псевдоним ec2_access_key устарел и будет удален в релизе после 2024-12-01. Поддержка переменной окружения `EC2_ACCESS_KEY` устарела и будет удалена в релизе после 2024-12-01.
aws_ca_bundle path	Расположение пакета CA, используемого при проверке SSL-сертификатов. Переменная окружения `AWS_CA_BUNDLE` также может использоваться.
aws_config dictionary	Словарь для изменения конфигурации botocore. Параметры можно найти в документации AWS https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.
capacity integer	Вместимость группы правил wafv2.
cloudwatch_metrics boolean	Включить метрику CloudWatch для группы правил wafv2 Варианты: `false` `true` ← (по умолчанию)
debug_botocore_endpoint_logs boolean	Использовать `botocore.endpoint` регистратор для анализа уникальных (а не общих) `"resource:action"` вызовов API, сделанных во время задачи, выводя набор в ключ resource_actions в результатах задачи. Используйте обратный вызов `aws_resource_action` для вывода в общий список, созданный во время выполнения playbook. Переменная окружения `ANSIBLE_DEBUG_BOTOCORE_LOGS` также может использоваться. Варианты: `false` ← (по умолчанию) `true`
description string	Описание группы правил wafv2.
endpoint_url aliases: ec2_url, aws_endpoint_url, s3_url string	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 string	Имя метрик CloudWatch. Если не указано, и cloudwatch_metrics включен, будет взято имя самой группы правил.
name string / required	Имя группы правил.
profile aliases: aws_profile string	Именованный профиль 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 boolean	При установке в `no`, существующие правила балансировщика нагрузки остаются на месте. Будут изменены и добавлены, но не удалены. Варианты: `false` `true` ← (по умолчанию)
purge_tags boolean	Если purge_tags=true и задан tags, существующие теги будут очищены из ресурса, чтобы точно соответствовать тому, что определено параметром tags. Если параметр tags не задан, теги не будут изменены, даже если purge_tags=True. Ключи тегов, начинающиеся с `aws:`, зарезервированы Amazon и не могут быть изменены. Таким образом, они будут игнорироваться для параметра purge_tags. См. документацию Amazon для получения дополнительной информации https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html#tag-conventions. Варианты: `false` `true` ← (по умолчанию)

регион псевдонимы: aws_region, ec2_region строка	Используемый регион AWS. Для глобальных сервисов, таких как IAM, Route53 и CloudFront, регион игнорируется. Также могут использоваться переменные среды `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.
правила список / элементы=словарь	Утверждения правил, используемые для определения веб-запросов, которые вы хотите разрешить, заблокировать или подсчитать.
выборка_запросов логическое	Выборка запросов, true или false. Выбор: `false` ← (по умолчанию) `true`
область строка / обязательно	Область действия группы правил wafv2. Выбор: `"CLOUDFRONT"` `"REGIONAL"`
секретный_ключ псевдонимы: aws_secret_access_key, aws_secret_key, ec2_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`, или `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.
токен_сессии псевдонимы: aws_session_token, security_token, aws_security_token, access_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`, `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.
состояние строка / обязательно	Присутствует или отсутствует правило. Выбор: `"present"` `"absent"`
метки псевдонимы: resource_tags словарь	Словарь, представляющий метки, которые нужно применить к ресурсу. Если параметр метки не задан, метки не будут изменены.
проверять_сертификаты логическое	При установке в значение `false`, сертификаты SSL для связи с API AWS не будут проверяться. Установка проверять_сертификаты=false категорически не рекомендуется; вместо этого рассмотрите возможность установки aws_ca_bundle. Выбор: `false` `true` ← (по умолчанию)

Примечания

Примечание

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

Примеры

- name: change description
  community.aws.wafv2_rule_group:
    name: test02
    state: present
    description: hallo eins zwei
    scope: REGIONAL
    capacity: 500
    rules:
      - name: eins
        priority: 1
        action:
          allow: {}
        visibility_config:
          sampled_requests_enabled: true
          cloud_watch_metrics_enabled: true
          metric_name: fsd
        statement:
          ip_set_reference_statement:
            arn: "{{ IPSET.arn }}"
    cloudwatch_metrics: true
    tags:
      A: B
      C: D
  register: out

- name: add rule
  community.aws.wafv2_rule_group:
    name: test02
    state: present
    description: hallo eins zwei
    scope: REGIONAL
    capacity: 500
    rules:
      - name: eins
        priority: 1
        action:
          allow: {}
        visibility_config:
          sampled_requests_enabled: true
          cloud_watch_metrics_enabled: true
          metric_name: fsd
        statement:
          ip_set_reference_statement:
            arn: "{{ IPSET.arn }}"
      - name: zwei
        priority: 2
        action:
          block: {}
        visibility_config:
          sampled_requests_enabled: true
          cloud_watch_metrics_enabled: true
          metric_name: ddos
        statement:
          or_statement:
            statements:
              - byte_match_statement:
                  search_string: ansible.com
                  positional_constraint: CONTAINS
                  field_to_match:
                    single_header:
                      name: host
                  text_transformations:
                    - type: LOWERCASE
                      priority: 0
              - xss_match_statement:
                  field_to_match:
                    body: {}
                  text_transformations:
                    - type: NONE
                      priority: 0
    cloudwatch_metrics: true
    tags:
      A: B
      C: D
  register: out

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

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

Ключ	Описание
arn строка	ARN группы правил Возвращаемое значение: Всегда, если веб-ACL существует Пример: `"arn:aws:wafv2:eu-central-1:11111111:regional/rulegroup/test02/6e90c01a-e4eb-43e5-b6aa-b1604cedf7d7"`
capacity целое число	Текущая емкость группы правил Возвращаемое значение: Всегда, если группа правил существует Пример: `500`
description строка	Описание группы правил Возвращаемое значение: Всегда, если веб-ACL существует Пример: `"Some rule group description"`
name строка	Имя группы правил Возвращаемое значение: Всегда, если группа правил существует Пример: `"test02"`
rules список / элементы=строка	Текущие правила группы правил Возвращаемое значение: Всегда, если группа правил существует Пример: `[{"action": {"allow": {}}, "name": "eins", "priority": 1, "statement": {"ip_set_reference_statement": {"arn": "arn:aws:wafv2:eu-central-1:11111111:regional/ipset/test02/b6978915-c67b-4d1c-8832-2b1bb452143a"}}, "visibility_config": {"cloud_watch_metrics_enabled": true, "metric_name": "fsd", "sampled_requests_enabled": true}}]`
visibility_config словарь	Настройки видимости группы правил Возвращаемое значение: Всегда, если группа правил существует Пример: `{"cloud_watch_metrics_enabled": true, "metric_name": "blub", "sampled_requests_enabled": false}`

Авторы

Markus Bergholz (@markuman)

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

© 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/wafv2_rule_group_module.html