Модуль community.aws.networkfirewall_policy — управление политиками AWS Network Firewall

access_key

псевдонимы: aws_access_key_id, aws_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 в порядке убывания приоритета.

Параметры aws_access_key и profile являются взаимоисключающими.

Псевдоним aws_access_key_id добавлен в выпуске 5.1.0 для согласованности с AWS botocore SDK.

arn

string

ARN политики Network Firewall.

Необходимо указать ровно один из параметров: arn или name.

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.

debug_botocore_endpoint_logs

boolean

Использовать регистратор botocore.endpoint для анализа уникальных (а не всех) вызовов API "resource:action", выполняемых во время задачи, и выводить их список в ключ resource_actions результатов задачи. Используйте callback aws_resource_action, чтобы вывести полный список вызовов, выполненных в ходе плейбука.

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

Возможные значения:

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

description

string

Описание политики Network Firewall.

endpoint_url

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

string

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

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

name

string

Имя политики Network Firewall.

Не может быть изменено после создания.

Необходимо указать ровно один из параметров: arn или name.

profile

псевдонимы: 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 и session_token.

purge_stateless_custom_actions

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

boolean

Если purge_stateless_custom_actions=true, существующие пользовательские действия будут удалены из ресурса, чтобы его содержимое точно соответствовало параметру stateless_custom_actions.

Возможные значения:

• 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 ← (по умолчанию)

region

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

string

Регион AWS для использования.

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

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

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

secret_key

псевдонимы: aws_secret_access_key, aws_secret_key

string

Секретный ключ доступа 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 botocore SDK.

session_token

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

string

Токен сеанса 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

string

Создать или удалить политику Network Firewall.

Возможные значения:

• "present" ← (по умолчанию)
• "absent"

stateful_default_actions

list / elements=string

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

Распространенные действия: aws:drop_strict, aws:drop_established, aws:alert_strict и aws:alert_established.

Допустимо только для политик, в которых задано strict_rule_order=true.

При создании новой политики по умолчанию используется aws:drop_strict.

stateful_rule_groups

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

list / elements=string

Список имен или ARN групп правил брандмауэра с сохранением состояния.

stateful_rule_order

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

string

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

При strict_rule_order=’strict’ правила и группы правил проверяются в заданном порядке.

Не может быть изменено после создания.

Возможные значения:

• "default"
• "strict"

stateless_custom_actions

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

list / elements=dictionary

Список словарей, определяющих пользовательские действия, которые можно использовать в параметрах stateless_default_actions и stateless_fragment_default_actions.

name

string / обязательный

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

publish_metric_dimension_value

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

string

При использовании пользовательского действия метрики будут содержать измерение CustomAction, значение которого задается параметром publish_metric_dimension_value.

stateless_default_actions

list / elements=string

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

Распространенные действия: aws:pass, aws:drop и aws:forward_to_sfe.

При создании новой политики по умолчанию используется aws:forward_to_sfe.

stateless_fragment_default_actions

list / elements=string

Действия, применяемые к фрагментированному UDP-пакету, если он не соответствует ни одному stateless-правилу в политике.

Распространенные действия: aws:pass, aws:drop и aws:forward_to_sfe.

При создании новой политики по умолчанию используется aws:forward_to_sfe.

stateless_rule_groups

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

list / elements=string

Список имен или ARN групп stateless-правил брандмауэра.

tags

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

dictionary

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

Если параметр tags не задан, теги не будут изменены.

validate_certs

boolean

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

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

Возможные значения:

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

wait

boolean

Ожидать ли, пока политика брандмауэра перейдет в состояние ACTIVE или DELETED, прежде чем модуль завершит работу.

Возможные значения:

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

wait_timeout

integer

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

По умолчанию — 600 секунд.

policy

dictionary

Сведения о политике

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

policy

dictionary

Сведения о политике

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

stateful_engine_options

dictionary

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

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

rule_order

string

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

Дополнительные сведения о порядке проверки правил см. в документации AWS: https://docs.aws.amazon.com/network-firewall/latest/developerguide/suricata-rule-evaluation-order.html.

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

Пример: "DEFAULT_ACTION_ORDER"

stateful_rule_group_references

list / elements=dictionary

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

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

priority

integer

Целое число, определяющее порядок выполнения групп правил с отслеживанием состояния в рамках одной политики.

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

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

Пример: 1234

resource_arn

string

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

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

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

stateless_custom_actions

list / elements=dictionary

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

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

action_definition

dictionary

Действие, которое необходимо выполнить.

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

publish_metric_action

dictionary

Определение пользовательской метрики для публикации в CloudWatch.

https://docs.aws.amazon.com/network-firewall/latest/developerguide/monitoring-cloudwatch.html

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

dimensions

list / elements=dictionary

Значения измерения CustomAction, задаваемые для метрик.

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

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

value

string

Значение измерения CustomAction, задаваемое для метрик.

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

Пример: "ExampleRule"

action_name

string

Название действия.

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

Пример: "ExampleAction"

stateless_default_actions

list / elements=string

Действия по умолчанию для пакета, не соответствующего ни одному правилу с отслеживанием состояния.

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

Пример: ["aws:alert_strict"]

stateless_fragment_default_actions

list / elements=string

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

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

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

stateless_rule_group_references

list / elements=dictionary

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

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

priority

string

Целое число, определяющее порядок выполнения групп правил без отслеживания состояния в рамках одной политики.

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

Пример: "12345"

resource_arn

string

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

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

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

policy_metadata

dictionary

Метаданные политики

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

consumed_stateful_rule_capacity

integer

Общее количество единиц ёмкости, используемых группами правил с отслеживанием состояния.

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

Пример: 165

consumed_stateless_rule_capacity

integer

Общее количество единиц ёмкости, используемых группами правил без отслеживания состояния.

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

Пример: 2010

firewall_policy_arn

string

ARN политики.

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

Пример: "arn:aws:network-firewall:us-east-1:123456789012:firewall-policy/ExamplePolicy"

firewall_policy_id

string

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

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

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

firewall_policy_name

string

Название политики.

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

Пример: "ExamplePolicy"

firewall_policy_status

string

Текущий статус политики.

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

Пример: "ACTIVE"

number_of_associations

integer

Количество брандмауэров, с которыми связана политика.

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

Пример: 1

tags

dictionary

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

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

Пример: {"tagName": "Some Value"}