Spec-Zone.ru › AWS CLI v2

[ aws . finspace ]

update-kx-environment-network

Описание

Обновляет сеть окружения для подключения к вашей внутренней сети с использованием шлюза транзита. Этот API поддерживает запросы на создание прикрепления шлюза транзита от VPC FinSpace к вашему идентификатору шлюза транзита и создание пользовательских разрешающих серверов Route-53 для исходящего трафика.

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

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

Синтаксис

  update-kx-environment-network
--environment-id <value>
[--transit-gateway-configuration <value>]
[--custom-dns-configuration <value>]
[--client-token <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]

Параметры

--environment-id (строка)

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

--transit-gateway-configuration (структура)

Определяет конфигурацию шлюза транзита и сети для подключения среды kdb к внутренней сети.

transitGatewayID -> (строка)

Идентификатор шлюза транзита, созданного клиентом для подключения исходящего трафика из сети kdb к вашей внутренней сети.

routableCIDRSpace -> (строка)

CIDR-диапазон маршрутизации от имени среды kdb. Он может быть любым диапазоном «/26» в пространстве CIDR 100.64.0.0. После предоставления он будет добавлен в таблицу маршрутизации шлюза транзита клиента, чтобы трафик мог быть маршрутизирован в сеть kdb.

attachmentNetworkAclConfiguration -> (список)

Правила, определяющие, как управлять исходящим трафиком из сети kdb в вашу внутреннюю сеть.

(структура)

Список управления доступом к сети (ACL) — это необязательный уровень безопасности для вашей VPC, который действует как брандмауэр для управления трафиком входящим и исходящим из одного или нескольких подсетей. Запись — это набор пронумерованных правил входящего и исходящего трафика, определяющих, разрешить или запретить пакету вход или выход из подсети, связанной с ACL. Мы обрабатываем записи в ACL в соответствии с номерами правил в порядке возрастания.

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

Номер правила для записи. Например, 100. Все записи ACL обрабатываются в порядке возрастания номера правила.

protocol -> (строка)

Номер протокола. Значение -1 означает все протоколы.

ruleAction -> (строка)

Указывает, разрешить или запретить трафик, соответствующий правилу.

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

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

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

Первый порт в диапазоне.

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

Последний порт в диапазоне.

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

Определяет протокол ICMP, состоящий из типа и кода ICMP.

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

Тип ICMP. Значение -1 означает все типы.

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

Код ICMP. Значение -1 означает все коды для указанного типа ICMP.

cidrBlock -> (строка)

Диапазон IPv4-сетей для разрешения или запрета в формате CIDR. Например, 172.16.0.0/24. Мы модифицируем указанный CIDR-блок до его канонической формы. Например, если вы укажете 100.68.0.18/18, мы изменим его на 100.68.0.0/18.

Синтаксис JSON:

{
  "transitGatewayID": "string",
  "routableCIDRSpace": "string",
  "attachmentNetworkAclConfiguration": [
    {
      "ruleNumber": integer,
      "protocol": "string",
      "ruleAction": "allow"|"deny",
      "portRange": {
        "from": integer,
        "to": integer
      },
      "icmpTypeCode": {
        "type": integer,
        "code": integer
      },
      "cidrBlock": "string"
    }
    ...
  ]
}

--custom-dns-configuration (список)

Список имен и IP-адресов DNS-серверов. Используется для настройки исходящих разрешающих серверов Route-53.

(структура)

Список имен и IP-адресов DNS-серверов. Используется для настройки исходящих разрешающих серверов Route-53.

customDNSServerName -> (строка)

Имя DNS-сервера.

customDNSServerIP -> (строка)

IP-адрес DNS-сервера.

Сокращенный синтаксис:

customDNSServerName=string,customDNSServerIP=string ...

Синтаксис JSON:

[
  {
    "customDNSServerName": "string",
    "customDNSServerIP": "string"
  }
  ...
]

--client-token (строка)

Токен, обеспечивающий идемпотентность. Этот токен истекает через 10 минут.

--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.

Вывод

name -> (строка)

Имя среды kdb.

environmentId -> (строка)

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

awsAccountId -> (строка)

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

status -> (строка)

Статус среды kdb.

tgwStatus -> (строка)

Статус конфигурации сети.

dnsStatus -> (строка)

Статус конфигурации DNS.

errorMessage -> (строка)

Указывает сообщение об ошибке, отображаемое при сбое потока.

description -> (строка)

Описание среды.

environmentArn -> (строка)

Идентификатор ARN среды.

kmsKeyId -> (строка)

Идентификатор ключа KMS для шифрования данных в среде FinSpace.

dedicatedServiceAccountId -> (строка)

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

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

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

transitGatewayID -> (строка)

Идентификатор транзитной точки доступа, созданной клиентом для подключения исходящего трафика из сети kdb к вашей внутренней сети.

routableCIDRSpace -> (строка)

Маршрутизируемый CIDR-пространство среды kdb. Может быть любым диапазоном «/26» в пространстве CIDR 100.64.0.0. После предоставления он будет добавлен в таблицу маршрутизации транзитной точки доступа клиента, чтобы трафик мог быть маршрутизирован в сеть kdb.

attachmentNetworkAclConfiguration -> (список)

Правила, определяющие, как управлять исходящим трафиком из сети kdb в вашу внутреннюю сеть.

(структура)

Список правил управления доступом к сети (ACL) — это необязательный уровень безопасности вашей VPC, который действует как брандмауэр для управления трафиком входящим и исходящим из одного или нескольких подсетей. Элемент представляет собой набор пронумерованных правил входящего и исходящего трафика, которые определяют, разрешать или запрещать пакет входящий или исходящий из подсети, связанной с ACL. Мы обрабатываем элементы в ACL в соответствии с номерами правил в порядке возрастания.

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

Номер правила для элемента. Например, 100. Все элементы списка правил ACL обрабатываются в порядке возрастания номера правила.

protocol -> (строка)

Номер протокола. Значение -1 означает все протоколы.

ruleAction -> (строка)

Указывает, разрешить или запретить трафик, соответствующий правилу.

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

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

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

Первый порт в диапазоне.

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

Последний порт в диапазоне.

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

Определяет протокол ICMP, состоящий из типа и кода ICMP.

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

Тип ICMP. Значение -1 означает все типы.

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

Код ICMP. Значение -1 означает все коды для указанного типа ICMP.

cidrBlock -> (строка)

Диапазон IPv4-сети для разрешения или запрета в формате CIDR. Например, 172.16.0.0/24. Мы изменяем указанный CIDR-блок в его каноническую форму. Например, если вы укажете 100.68.0.18/18, мы изменим его на 100.68.0.0/18.

customDNSConfiguration -> (список)

Список имен и IP-адресов DNS-серверов. Используется для настройки исходящих разрешающих серверов Route-53.

(структура)

Список имен и IP-адресов DNS-серверов. Используется для настройки исходящих разрешающих серверов Route-53.

customDNSServerName -> (строка)

Имя DNS-сервера.

customDNSServerIP -> (строка)

IP-адрес DNS-сервера.

creationTimestamp -> (метка времени)

Отметка времени создания среды kdb в FinSpace.

updateTimestamp -> (метка времени)

Отметка времени обновления среды kdb.

availabilityZoneIds -> (список)

Идентификатор зон доступности, где созданы подсети для среды.

(строка)

© Copyright 2025, Amazon Web Services. Created using Sphinx.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API