describe-firewall

Описание

Возвращает объекты данных для указанного межсетевого экрана.

См. также: Документация API AWS

Синтаксис

  describe-firewall
[--firewall-name <value>]
[--firewall-arn <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Параметры

--firewall-name (строка)

Дескриптивное имя межсетевого экрана. Вы не можете изменить имя межсетевого экрана после его создания.

Вы должны указать ARN или имя, и вы можете указать оба.

--firewall-arn (строка)

Amazon Resource Name (ARN) межсетевого экрана.

Вы должны указать ARN или имя, и вы можете указать оба.

--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной JSON-строки. JSON-строка соответствует формату, предоставленному --generate-cli-skeleton. Если на командной строке предоставлены другие аргументы, эти значения переопределят значения, предоставленные JSON. Невозможно передавать произвольные двоичные значения с помощью предоставленного JSON-значения, так как строка будет принята буквально. Это не может быть указано вместе с --cli-input-yaml.

--generate-cli-skeleton (строка) Выводит JSON-скелет в стандартный вывод без отправки запроса API. Если предоставлено значение без значения или значение input, выводит пример входного JSON, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, если предоставлено yaml-input, он выведет пример входного YAML, который можно использовать с --cli-input-yaml. Если предоставлено значение output, он валидирует входные данные команды и возвращает пример выходного JSON для этой команды. Сгенерированный JSON-скелет нестабилен между версиями AWS CLI, и нет гарантий обратной совместимости в сгенерированном JSON-скелете.

Глобальные параметры

--debug (логическое значение)

Включить отладку регистрации.

--endpoint-url (строка)

Переопределить URL по умолчанию команды заданным URL.

--no-verify-ssl (логическое значение)

По умолчанию AWS CLI использует SSL при общении с AWS-сервисами. Для каждого SSL-соединения AWS CLI будет проверять SSL-сертификаты. Этот параметр переопределяет стандартное поведение проверки SSL-сертификатов.

--no-paginate (логическое значение)

Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один вызов для первой страницы результатов.

--output (строка)

Стиль форматирования для вывода команды.

json
текст
таблица
yaml
yaml-поток

--query (строка)

Запрос JMESPath для фильтрации данных ответа.

--profile (строка)

Использовать определенный профиль из вашего файла учетных данных.

--region (строка)

Область для использования. Переопределяет настройки конфигурации/среды.

--version (строка)

Отобразить версию этого инструмента.

--color (строка)

Включить/выключить цветной вывод.

включено
выключено
автоматически

--no-sign-request (логическое значение)

Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент предоставлен.

--ca-bundle (строка)

Файл сертификата CA для использования при проверке SSL-сертификатов. Переопределяет настройки конфигурации/среды.

--cli-read-timeout (целое число)

Максимальное время чтения сокета в секундах. Если значение равно 0, чтение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию составляет 60 секунд.

--cli-connect-timeout (целое число)

Максимальное время подключения сокета в секундах. Если значение равно 0, подключение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию составляет 60 секунд.

--cli-binary-format (строка)

Стиль форматирования, используемый для двоичных блоков. Формат по умолчанию — base64. Формат base64 ожидает, что двоичные блоки будут предоставлены как закодированная в base64 строка. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI V1, и двоичные значения должны быть переданы буквально. При предоставлении содержимого из файла, соответствующего двоичному блоку, fileb:// всегда будет обрабатываться как двоичный и использовать содержимое файла непосредственно независимо от настройки cli-binary-format. При использовании file:// содержимое файла должно быть должным образом отформатировано для настроенного cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (логическое значение)

Отключить диспетчер cli для вывода.

--cli-auto-prompt (логическое значение)

Автоматически запросить параметры ввода CLI.

--no-cli-auto-prompt (логическое значение)

Отключить автоматическое запросить параметры ввода CLI.

Вывод

UpdateToken -> (строка)

Необязательный маркер, который можно использовать для оптимистической блокировки. Network Firewall возвращает маркер для ваших запросов, которые обращаются к межсетевому экрану. Маркер отмечает состояние ресурса межсетевого экрана на момент запроса.

Чтобы внести безусловное изменение в межсетевой экран, опустите маркер в запросе обновления. Без маркера Network Firewall выполняет обновления независимо от того, изменился ли межсетевой экран с момента последнего получения.

Чтобы внести условное изменение в межсетевой экран, предоставьте маркер в запросе обновления. Network Firewall использует маркер для проверки того, не изменился ли межсетевой экран с момента последнего получения. Если он изменился, операция завершится с InvalidTokenException. Если это произойдет, снова получите межсетевой экран, чтобы получить текущую копию с новым маркером. Повторно примените ваши изменения по мере необходимости, затем повторите операцию с использованием нового маркера.

Firewall -> (структура)

Настройки конфигурации межсетевого экрана. Эти настройки включают политику межсетевого экрана и подсети в вашей VPC для использования в точках межсетевого экрана.

FirewallName -> (строка)

Дескриптивное имя межсетевого экрана. Вы не можете изменить имя межсетевого экрана после его создания.

FirewallArn -> (строка)

Amazon Resource Name (ARN) межсетевого экрана.

FirewallPolicyArn -> (строка)

Amazon Resource Name (ARN) политики межсетевого экрана.

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

VpcId -> (строка)

Уникальный идентификатор VPC, в котором используется межсетевой экран.

SubnetMappings -> (список)

Общедоступные подсети, которые Network Firewall использует для межсетевого экрана. Каждая подсеть должна принадлежать разным зонам доступности.

(структура)

Идентификатор подсети, которую вы хотите связать с межсетевым экраном. Это используется с CreateFirewall и AssociateSubnets. Network Firewall создает экземпляр связанного межсетевого экрана в каждой указанной вами подсети для фильтрации трафика в зоне доступности подсети.

SubnetId -> (строка)

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

IPAddressType -> (строка)

Тип IP-адреса подсети. Вы не можете изменить тип IP-адреса после создания подсети.

DeleteProtection -> (логическое значение)

Флаг, указывающий, можно ли удалить межсетевой экран. Значение TRUE указывает, что межсетевой экран защищен от удаления. Используйте это значение, чтобы защитить от случайного удаления межсетевого экрана, который используется. При создании межсетевого экрана операция инициализирует этот флаг значением TRUE.

SubnetChangeProtection -> (логическое значение)

Настройка, указывающая, защищен ли межсетевой экран от изменений в ассоциациях подсети. Используйте это значение, чтобы защитить от случайного изменения ассоциаций подсети для межсетевого экрана, который используется. При создании межсетевого экрана операция инициализирует эту настройку значением TRUE.

FirewallPolicyChangeProtection -> (логическое значение)

Настройка, указывающая, защищен ли межсетевой экран от изменения ассоциации политики межсетевого экрана. Используйте это значение, чтобы защитить от случайного изменения политики межсетевого экрана для межсетевого экрана, который используется. При создании межсетевого экрана операция инициализирует эту настройку значением TRUE.

Description -> (строка)

Описание межсетевого экрана.

FirewallId -> (строка)

Уникальный идентификатор межсетевого экрана.

Tags -> (список)

(структура)

Пара ключ:значение, связанная с ресурсом Amazon Web Services. Пара ключ:значение может быть любой, которую вы определите. Обычно ключ тега представляет категорию (например, «среда»), а значение тега представляет определенное значение в этой категории (например, «тест», «разработка» или «производство»). Вы можете добавить до 50 тегов к каждому ресурсу Amazon Web Services.

Key -> (строка)

Часть пары ключ:значение, определяющая тег. Вы можете использовать ключ тега для описания категории информации, например, «клиент». Ключи тегов чувствительны к регистру.

Value -> (строка)

Часть пары ключ:значение, определяющая тег. Вы можете использовать значение тега для описания определенного значения в категории, например, «companyA» или «companyB». Значения тегов чувствительны к регистру.

EncryptionConfiguration -> (структура)

Сложный тип, содержащий настройки конфигурации шифрования Amazon Web Services KMS для вашего межсетевого экрана.

KeyId -> (строка)

Идентификатор управляемого клиентом ключа Amazon Web Services Key Management Service (KMS). Вы можете использовать любой из идентификаторов ключей, поддерживаемых KMS, если вы не используете ключ, управляемый другим аккаунтом. Если вы используете ключ, управляемый другим аккаунтом, укажите ARN ключа. Дополнительную информацию см. в разделе Идентификатор ключа в руководстве разработчика Amazon Web Services KMS.

Type -> (строка)

Тип ключа Amazon Web Services KMS, который следует использовать для шифрования ваших ресурсов Network Firewall.

EnabledAnalysisTypes -> (список)

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

(строка)

FirewallStatus -> (структура)

Подробная информация о текущем состоянии брандмауэра. Вы можете получить ее, вызвав DescribeFirewall и указав имя брандмауэра и ARN.

Status -> (строка)

Готовность настроенного брандмауэра обрабатывать сетевой трафик во всех зонах доступности, где он настроен. Это значение имеет смысл только когда значение ConfigurationSyncStateSummary равно IN_SYNC, и значения Attachment Status для всех настроенных подсетей равны READY.

ConfigurationSyncStateSummary -> (строка)

Состояние синхронизации конфигурации брандмауэра. Это обобщение состояний синхронизации, указанных в настройках Config для всех зон доступности, где настроен брандмауэр.

При создании или обновлении конфигурации брандмауэра, например, добавлении группы правил в политику брандмауэра, Network Firewall распространяет изменения конфигурации во все зоны, где используется брандмауэр. Данное сводное значение указывает, были ли изменения конфигурации применены везде.

Это состояние должно быть IN_SYNC для того, чтобы брандмауэр был готов к использованию, но не указывает, что брандмауэр готов. Значение Status указывает готовность брандмауэра.

SyncStates -> (массив)

Подсети, настроенные для использования брандмауэром Network Firewall. Этот элемент содержит по одному элементу массива на каждую зону доступности, где настраивается подсеть. Эти объекты предоставляют подробную информацию, обобщенную в ConfigurationSyncStateSummary и Status, разбитую по зонам и объектам конфигурации.

key -> (строка)

value -> (структура)

Состояние конечной точки брандмауэра и конфигурации политики брандмауэра для одной подсети VPC.

Для каждой подсети VPC, связанной с брандмауэром, Network Firewall выполняет следующие действия:

Создаёт конечную точку брандмауэра в подсети, готовой принимать трафик.
Настраивает конечную точку с текущими настройками политики брандмауэра, чтобы обеспечить поведение фильтрации для конечной точки.

При обновлении брандмауэра, например, для добавления ассоциации подсети или изменения группы правил в политике брандмауэра, затронутые состояния синхронизации отражают состояние "не синхронизирован" или "не готово", пока изменения не будут завершены.

Attachment -> (структура)

Состояние привязки ассоциации брандмауэра с одной подсетью VPC. Для каждой настроенной подсети Network Firewall создаёт привязку, создавая конечную точку брандмауэра в подсети, чтобы она была готова принимать трафик. Это часть FirewallStatus.

SubnetId -> (строка)

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

EndpointId -> (строка)

Идентификатор конечной точки брандмауэра, созданной Network Firewall в подсети. Вы используете его для идентификации конечной точки брандмауэра в таблицах маршрутизации VPC при перенаправлении трафика VPC через конечную точку.

Status -> (строка)

Текущее состояние конечной точки брандмауэра в подсети. Это значение отражает как создание конечной точки в подсети VPC, так и состояния синхронизации, указанные в настройках Config. Когда это значение равно READY, конечная точка доступна и должным образом настроена для обработки сетевого трафика. Когда конечная точка недоступна для трафика, это значение будет отражать её состояние, например, CREATING или DELETING.

StatusMessage -> (строка)

Если Network Firewall не удаётся создать или удалить конечную точку брандмауэра в подсети, он заполняет это поле причиной ошибки или сбоя, и как её исправить. Состояние FAILED указывает невосстанавливаемое состояние, а состояние ERROR указывает проблему, которую можно исправить. В зависимости от ошибки, заполнение этого поля может занять до 15 минут. Дополнительную информацию о причинах сбоев или ошибок и доступных решениях для этого поля можно найти в разделе Устранение неполадок в работе конечной точки брандмауэра в Руководстве разработчика Network Firewall.

Config -> (массив)

Состояние конфигурации конечной точки брандмауэра в одной подсети VPC. Network Firewall предоставляет каждой конечной точке правила, настроенные в политике брандмауэра. Каждый раз, когда вы добавляете подсеть или изменяете связанную политику брандмауэра, Network Firewall синхронизирует правила в конечной точке, чтобы она могла правильно фильтровать сетевой трафик. Это часть FirewallStatus.

key -> (строка)

value -> (структура)

Предоставляет состояние конфигурации для одной политики или группы правил, используемых для конечной точки брандмауэра. Network Firewall предоставляет каждой конечной точке правила, настроенные в политике брандмауэра. Каждый раз, когда вы добавляете подсеть или изменяете связанную политику брандмауэра, Network Firewall синхронизирует правила в конечной точке, чтобы она могла правильно фильтровать сетевой трафик. Это часть SyncState для брандмауэра.

SyncStatus -> (строка)

Указывает, синхронизирован ли данный объект с версией, указанной в марке обновления.

UpdateToken -> (строка)

Текущая версия объекта, которая либо синхронизирована, либо ожидает синхронизации.

CapacityUsageSummary -> (структура)

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

CIDRs -> (структура)

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

AvailableCIDRCount -> (целое число)

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

UtilizedCIDRCount -> (целое число)

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

IPSetReferences -> (массив)

Список ссылок на наборы IP, используемых брандмауэром.

key -> (строка)

value -> (структура)

Общая информация о наборе IP.

ResolvedCIDRCount -> (целое число)

Описание общего количества блоков CIDR, которые в настоящее время используются ссылками на наборы IP в брандмауэре. Чтобы определить, сколько блоков CIDR доступно для использования в брандмауэре, вы можете вызвать AvailableCIDRCount.