Модуль community.aws.networkfirewall_rule_group_info – описание групп правил AWS Network Firewall

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.

arn

строка

ARN группы правил Network Firewall.

На момент написания документации AWS не поддерживает описание управляемых правил.

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

endpoint_url

псевдонимы: aws_endpoint_url

строка

URL для подключения вместо конечных точек AWS по умолчанию. Хотя этот параметр можно использовать для подключения к другим совместимым с AWS сервисам, коллекции amazon.aws и community.aws проходят тестирование только с AWS.

Также можно использовать переменную среды AWS_URL.

name

строка

Имя группы правил Network Firewall.

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.

region

псевдонимы: aws_region

строка

Регион AWS.

Для глобальных сервисов, таких как IAM, Route53 и CloudFront, параметр region игнорируется.

Также можно использовать переменную среды AWS_REGION.

Дополнительные сведения см. в документации Amazon AWS: http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region.

rule_type

псевдонимы: type

строка

Указывает, является ли группа правил stateless или stateful.

Обязателен, если задан параметр name.

Варианты:

• "stateful"
• "stateless"

scope

строка

Область запроса.

При значении scope=’account’ возвращает описание всех групп правил в учетной записи.

При значении scope=’managed’ возвращает список доступных ARN управляемых групп правил.

По умолчанию поиск выполняется только в области учетной записи.

Варианты:

• "managed"
• "account"

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 являются взаимоисключающими.

validate_certs

логический

Если задано значение false, SSL-сертификаты при взаимодействии с API AWS проверяться не будут.

Настоятельно не рекомендуется устанавливать validate_certs=false; вместо этого рассмотрите возможность указать параметр aws_ca_bundle.

Варианты:

• false
• true ← (по умолчанию)

rule_groups

list / elements=dictionary

Сведения о группах правил

Возвращается: при успешном выполнении

rule_group

dictionary

Сведения о правилах в группе правил

Возвращается: при успешном выполнении

rule_variables

complex

Параметры, доступные для использования в правилах группы правил.

Возвращается: если к группе правил прикреплены переменные правил.

ip_sets

dictionary

Словарь, сопоставляющий имена переменных с IP-адресами в формате CIDR.

Возвращается: при успешном выполнении

Пример: ["192.0.2.0/24"]

port_sets

dictionary

Словарь, сопоставляющий имена переменных с портами

Возвращается: при успешном выполнении

Пример: ["42"]

rules_source

dictionary

DEFAULT_ACTION_ORDER

Возвращается: при успешном выполнении

rules_source_list

dictionary

Описание критериев для группы правил со списком доменов.

Возвращается: если группа правил основана на «списке доменов».

generated_rules_type

string

Определяет, разрешает или запрещает группа правил доступ к доменам из списка.

Возвращается: при успешном выполнении

Пример: "ALLOWLIST"

target_types

list / elements=string

Протоколы, которые должна проверять группа правил.

Возвращается: при успешном выполнении

Пример: ["TLS_SNI", "HTTP_HOST"]

targets

list / elements=string

Список доменных имен для проверки.

Возвращается: при успешном выполнении

Пример: ["abc.example.com", ".example.net"]

rules_string

string

Строка с описанием правил, из которых состоит группа правил.

Возвращается: если группа правил основана на «строке правил».

stateful_rules

list / elements=dictionary

Список словарей с описанием правил, из которых состоит группа правил.

Возвращается: если группа правил основана на «списке правил».

action

string

Действие, выполняемое при соответствии потока критериям правила.

Возвращается: при успешном выполнении

Пример: "PASS"

header

dictionary

Описание критериев, используемых для правила.

Возвращается: при успешном выполнении

destination

string

Адрес назначения или диапазон адресов для проверки.

Возвращается: при успешном выполнении

Пример: "198.51.100.0/24"

destination_port

string

Порт назначения для проверки.

Возвращается: при успешном выполнении

Пример: "6666:6667"

direction

string

Направление проверяемого потока трафика.

Возвращается: при успешном выполнении

Пример: "FORWARD"

protocol

string

Протокол для проверки.

Возвращается: при успешном выполнении

Пример: "IP"

source

string

Адрес источника или диапазон адресов для проверки.

Возвращается: при успешном выполнении

Пример: "203.0.113.98"

source_port

string

Порт источника для проверки.

Возвращается: при успешном выполнении

Пример: "42"

rule_options

list / elements=dictionary

Дополнительные параметры RuleOptions для правила Suricata.

Возвращается: при успешном выполнении

keyword

string

Ключевое слово для параметра.

Возвращается: при успешном выполнении

Пример: "sid:1"

settings

list / elements=string

Список значений, переданных параметру.

Возвращается: если значения доступны

stateless_rules_and_custom_actions

dictionary

Описание критериев для группы правил без отслеживания состояния.

Возвращается: если группа правил не отслеживает состояние.

custom_actions

list / elements=dictionary

Список отдельных определений пользовательских действий, доступных для использования в правилах без отслеживания состояния.

Возвращается: при успешном выполнении

action_definition

dictionary

Пользовательское действие, связанное с именем действия.

Возвращается: при успешном выполнении

publish_metric_action

dictionary

Описание действия, которое публикует данные в CloudWatch.

Возвращается: когда действие публикует данные в CloudWatch.

dimensions

list / elements=dictionary

Значение, используемое в пользовательском измерении метрики Amazon CloudWatch.

Возвращается: при успешном выполнении

value

string

Значение, используемое в пользовательском измерении метрики.

Возвращается: при успешном выполнении

action_name

string

Имя пользовательского действия.

Возвращается: при успешном выполнении

stateless_rules

list / elements=dictionary

Список правил без отслеживания состояния для использования в соответствующей группе правил.

Возвращается: при успешном выполнении

priority

integer

Задает порядок выполнения этого правила относительно всех правил, определенных для группы правил без отслеживания состояния.

Возвращается: при успешном выполнении

rule_definition

dictionary

Описывает критерии проверки 5-кортежа без отслеживания состояния и действия для правила.

Возвращается: при успешном выполнении

actions

list / elements=string

Действия, выполняемые при соответствии потока правилу.

Возвращается: при успешном выполнении

Пример: ["aws:pass", "CustomActionName"]

match_attributes

dictionary

Описывает критерии проверки 5-кортежа без отслеживания состояния для правила.

Возвращается: при успешном выполнении

destination_ports

list / elements=dictionary

Диапазоны портов назначения для проверки.

Возвращается: при успешном выполнении

from_port

integer

Нижняя граница диапазона портов.

Возвращается: при успешном выполнении

to_port

integer

Верхняя граница диапазона портов.

Возвращается: при успешном выполнении

destinations

list / elements=dictionary

IP-адреса назначения и диапазоны адресов для проверки.

Возвращается: при успешном выполнении

address_definition

string

IP-адрес или блок IP-адресов в нотации CIDR.

Возвращается: при успешном выполнении

Пример: "192.0.2.3"

protocols

list / elements=integer

Номера протоколов IANA, которые требуется проверять.

Возвращается: при успешном выполнении

Пример: [6]

source_ports

list / elements=dictionary

Диапазоны портов источника для проверки.

Возвращается: при успешном выполнении

from_port

integer

Нижняя граница диапазона портов.

Возвращается: при успешном выполнении

to_port

integer

Верхняя граница диапазона портов.

Возвращается: при успешном выполнении

sources

list / elements=dictionary

IP-адреса источника и диапазоны адресов для проверки.

Возвращается: при успешном выполнении

address_definition

string

IP-адрес или блок IP-адресов в нотации CIDR.

Возвращается: при успехе

Пример: "192.0.2.3"

tcp_flags

list / elements=dictionary

Флаги и маски TCP, которые необходимо проверять.

Возвращается: при успехе

flags

list / elements=string

Используются вместе с масками для определения флагов TCP, которые проверяются в потоках.

Возвращается: при успехе

masks

list / elements=string

Набор флагов, учитываемых при проверке.

Возвращается: при успехе

stateful_rule_options

dictionary

Дополнительные параметры, определяющие обработку правил с сохранением состояния в Network Firewall.

Возвращается: если группа правил основана на «строке правил» или «списке правил».

rule_order

string

Порядок проверки правил.

Возвращается: при успехе

Пример: "DEFAULT_ACTION_ORDER"

rule_group_metadata

dictionary

Сведения о правилах в группе правил

Возвращается: при успехе

capacity

integer

Максимальный объем ресурсов, который может использовать эта группа правил.

Возвращается: при успехе

consumed_capacity

integer

Количество единиц емкости, используемых в данный момент правилами группы.

Возвращается: при успехе

description

string

Описание группы правил.

Возвращается: при успехе

number_of_associations

integer

Количество политик брандмауэра, использующих эту группу правил.

Возвращается: при успехе

rule_group_arn

integer

ARN группы правил

Возвращается: при успехе

Пример: "arn:aws:network-firewall:us-east-1:123456789012:stateful-rulegroup/ExampleGroup"

rule_group_id

integer

Уникальный идентификатор группы правил.

Возвращается: при успехе

Пример: "12345678-abcd-1234-abcd-123456789abc"

rule_group_name

string

Название группы правил.

Возвращается: при успехе

rule_group_status

string

Текущий статус группы правил.

Возвращается: при успехе

Пример: "DELETING"

tags

dictionary

Словарь, представляющий теги, связанные с группой правил.

Возвращается: при успехе

type

string

Определяет, является ли группа правил группой без сохранения состояния или с сохранением состояния.

Возвращается: при успехе

Пример: "STATEFUL"

rule_list

list / elements=string

Список ARN соответствующих групп правил.

Возвращается: если имя правила не указано