update-virtual-gateway
Описание
Обновляет существующий виртуальный шлюз в указанной службе сетки.
См. также: Документация AWS API
Синтаксис
update-virtual-gateway
[--client-token <value>]
--mesh-name <value>
[--mesh-owner <value>]
--spec <value>
--virtual-gateway-name <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]
Параметры
--client-token (строка)
--mesh-name (строка)
--mesh-owner (строка)
--spec (структура)
Новая спецификация виртуального шлюза для применения. Это перезаписывает существующие данные.
backendDefaults -> (структура)
Ссылка на объект, представляющий значения по умолчанию для бэкендов.
clientPolicy -> (структура)
Ссылка на объект, представляющий политику клиента.
tls -> (структура)
Ссылка на объект, представляющий политику клиента Transport Layer Security (TLS).
certificate -> (структура помеченных объединений)
Ссылка на объект, представляющий сертификат Transport Layer Security (TLS) клиента виртуального шлюза.
Примечание
Это структура помеченных объединений. Может быть задан только один из следующих ключей верхнего уровня:file, sds.file -> (структура)
Объект, представляющий локальный сертификат файла. Сертификат должен соответствовать определенным требованиям, и вы должны иметь включенную авторизацию прокси. Дополнительную информацию см. в разделе Transport Layer Security (TLS).
certificateChain -> (строка)
privateKey -> (строка)
sds -> (структура)
Ссылка на объект, представляющий сертификат Secret Discovery Service клиента виртуального шлюза.
secretName -> (строка)
enforce -> (булево)
True, если значение не указано.ports -> (список)
Один или несколько портов, для которых применяется политика.
(целое число)
validation -> (структура)
Ссылка на объект, представляющий контекст проверки Transport Layer Security (TLS).
subjectAlternativeNames -> (структура)
Ссылка на объект, представляющий SAN для контекста проверки Transport Layer Security (TLS) слушателя виртуального шлюза.
match -> (структура)
Объект, представляющий критерии для определения соответствия SAN.
exact -> (список)
Передаваемые значения должны точно совпадать с указанными значениями.
(строка)
trust -> (структура помеченных объединений)
Ссылка на место получения цепочки доверия при проверке сертификата Transport Layer Security (TLS) peer.
Примечание
Это структура помеченных объединений. Может быть задан только один из следующих ключей верхнего уровня:acm, file, sds.acm -> (структура)
Ссылка на объект, представляющий контекст доверия Transport Layer Security (TLS) для сертификата Certificate Manager.
certificateAuthorityArns -> (список)
Один или несколько ARN ACM Amazon.
(строка)
file -> (структура)
Объект, представляющий контекст доверия Transport Layer Security (TLS) для локального файла.
certificateChain -> (строка)
sds -> (структура)
Ссылка на объект, представляющий контекст доверия Transport Layer Security (TLS) Secret Discovery Service виртуального шлюза.
secretName -> (строка)
listeners -> (список)
Слушатели, от которых ожидается, что узел сетки будет получать входящий трафик. Вы можете указать один слушатель.
(структура)
Объект, представляющий слушателя для виртуального шлюза.
connectionPool -> (структура помеченных объединений)
Информация о пуле подключений для слушателя виртуального шлюза.
Примечание
Это структура помеченных объединений. Может быть задан только один из следующих ключей верхнего уровня:grpc, http, http2.grpc -> (структура)
Объект, представляющий тип пула подключений.
maxRequests -> (целое число)
http -> (структура)
Объект, представляющий тип пула подключений.
maxConnections -> (целое число)
maxPendingRequests -> (целое число)
max_connections.http2 -> (структура)
Объект, представляющий тип пула подключений.
maxRequests -> (целое число)
healthCheck -> (структура)
Информация о проверке работоспособности для слушателя.
healthyThreshold -> (целое число)
intervalMillis -> (длинное целое число)
path -> (строка)
port -> (целое число)
protocol -> (строка)
grpc, то ваш сервис должен соответствовать протоколу проверки работоспособности GRPC.timeoutMillis -> (длинное целое число)
unhealthyThreshold -> (целое число)
portMapping -> (структура)
Информация о сопоставлении портов для слушателя.
port -> (целое число)
protocol -> (строка)
tls -> (структура)
Ссылка на объект, представляющий свойства Transport Layer Security (TLS) для слушателя.
certificate -> (структура помеченных объединений)
Объект, представляющий сертификат Transport Layer Security (TLS).
Примечание
Это структура помеченных объединений. Может быть задан только один из следующих ключей верхнего уровня:acm, file, sds.acm -> (структура)
Ссылка на объект, представляющий сертификат Certificate Manager.
certificateArn -> (строка)
file -> (структура)
Ссылка на объект, представляющий локальный сертификат файла.
certificateChain -> (строка)
privateKey -> (строка)
sds -> (структура)
Ссылка на объект, представляющий сертификат Secret Discovery Service слушателя виртуального шлюза.
secretName -> (строка)
mode -> (строка)
Укажите один из следующих режимов.
- STRICT – Слушатель принимает только соединения с включенным TLS.
- PERMISSIVE – Слушатель принимает соединения с включенным или выключенным TLS.
- DISABLED – Слушатель принимает только соединения без TLS.
validation -> (структура)
Ссылка на объект, представляющий контекст проверки Transport Layer Security (TLS) слушателя виртуального шлюза.
subjectAlternativeNames -> (структура)
Ссылка на объект, представляющий SAN для контекста проверки Transport Layer Security (TLS) слушателя виртуального шлюза.
match -> (структура)
Объект, представляющий критерии для определения соответствия SAN.
exact -> (список)
Передаваемые значения должны точно совпадать с указанными значениями.
(строка)
trust -> (структура помеченных объединений)
Ссылка на место получения цепочки доверия при проверке сертификата Transport Layer Security (TLS) peer.
Примечание
Это структура помеченных объединений. Может быть задан только один из следующих ключей верхнего уровня:file, sds.file -> (структура)
Объект, представляющий контекст доверия Transport Layer Security (TLS) для локального файла.
certificateChain -> (строка)
sds -> (структура)
Ссылка на объект, представляющий контекст доверия Transport Layer Security (TLS) Secret Discovery Service слушателя виртуального шлюза.
secretName -> (строка)
logging -> (структура)
Объект, представляющий информацию о регистрации.
accessLog -> (структура помеченного объединения)
Настройка журнала доступа.
Примечание
Это структура помеченного объединения. Только один из следующих ключей верхнего уровня может быть задан:file.file -> (структура)
Объект файла для отправки журналов доступа виртуального шлюза.
format -> (структура помеченного объединения)
Указанный формат журналов доступа виртуального шлюза. Он может быть либо json_format, либо text_format.
Примечание
Это структура помеченного объединения. Только один из следующих ключей верхнего уровня может быть задан:json, text.json -> (список)
(структура)
Объект, представляющий пары ключ-значение для JSON.
key -> (строка)
value -> (строка)
text -> (строка)
path -> (строка)
/dev/stdout для отправки журналов доступа в стандартный вывод и настроить свой контейнер Envoy для использования драйвера журналов, такого как awslogs, чтобы экспортировать журналы доступа в службу хранения журналов, такую как Amazon CloudWatch Logs. Вы также можете указать путь в файловой системе контейнера Envoy для записи файлов на диск.Синтаксис JSON:
{
"backendDefaults": {
"clientPolicy": {
"tls": {
"certificate": {
"file": {
"certificateChain": "string",
"privateKey": "string"
},
"sds": {
"secretName": "string"
}
},
"enforce": true|false,
"ports": [integer, ...],
"validation": {
"subjectAlternativeNames": {
"match": {
"exact": ["string", ...]
}
},
"trust": {
"acm": {
"certificateAuthorityArns": ["string", ...]
},
"file": {
"certificateChain": "string"
},
"sds": {
"secretName": "string"
}
}
}
}
}
},
"listeners": [
{
"connectionPool": {
"grpc": {
"maxRequests": integer
},
"http": {
"maxConnections": integer,
"maxPendingRequests": integer
},
"http2": {
"maxRequests": integer
}
},
"healthCheck": {
"healthyThreshold": integer,
"intervalMillis": long,
"path": "string",
"port": integer,
"protocol": "http"|"http2"|"grpc",
"timeoutMillis": long,
"unhealthyThreshold": integer
},
"portMapping": {
"port": integer,
"protocol": "http"|"http2"|"grpc"
},
"tls": {
"certificate": {
"acm": {
"certificateArn": "string"
},
"file": {
"certificateChain": "string",
"privateKey": "string"
},
"sds": {
"secretName": "string"
}
},
"mode": "STRICT"|"PERMISSIVE"|"DISABLED",
"validation": {
"subjectAlternativeNames": {
"match": {
"exact": ["string", ...]
}
},
"trust": {
"file": {
"certificateChain": "string"
},
"sds": {
"secretName": "string"
}
}
}
}
}
...
],
"logging": {
"accessLog": {
"file": {
"format": {
"json": [
{
"key": "string",
"value": "string"
}
...
],
"text": "string"
},
"path": "string"
}
}
}
}
--virtual-gateway-name (строка)
--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
- text
- таблица
- 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.
Вывод
virtualGateway -> (структура)
Полное описание обновленного виртуального шлюза.
meshName -> (строка)
metadata -> (структура)
Объект, представляющий метаданные для ресурса.
arn -> (строка)
createdAt -> (временная метка)
lastUpdatedAt -> (временная метка)
meshOwner -> (строка)
resourceOwner -> (строка)
uid -> (строка)
version -> (длинное целое число)
spec -> (структура)
Характеристики виртуального шлюза.
backendDefaults -> (структура)
Ссылка на объект, представляющий значения по умолчанию для бэкендов.
clientPolicy -> (структура)
Ссылка на объект, представляющий политику клиента.
tls -> (структура)
Ссылка на объект, представляющий политику клиента Transport Layer Security (TLS).
certificate -> (структура помеченных союзов)
Ссылка на объект, представляющий сертификат Transport Layer Security (TLS) клиента виртуального шлюза.
Примечание
Это структура помеченных союзов. Может быть задан только один из следующих ключей верхнего уровня:file, sds.file -> (структура)
Объект, представляющий сертификат локального файла. Сертификат должен соответствовать определённым требованиям, и у вас должна быть включена авторизация прокси. Дополнительную информацию см. в разделе Transport Layer Security (TLS).
certificateChain -> (строка)
privateKey -> (строка)
sds -> (структура)
Ссылка на объект, представляющий сертификат Secret Discovery Service клиента виртуального шлюза.
secretName -> (строка)
enforce -> (булево)
True, если значение не указано.ports -> (список)
Один или несколько портов, для которых выполняется политика.
(целое число)
validation -> (структура)
Ссылка на объект, представляющий контекст проверки Transport Layer Security (TLS).
subjectAlternativeNames -> (структура)
Ссылка на объект, представляющий SAN для контекста проверки Transport Layer Security (TLS) слушателя виртуального шлюза.
match -> (структура)
Объект, представляющий критерии для определения соответствия SAN.
exact -> (список)
Отправленные значения должны точно совпадать с указанными значениями.
(строка)
trust -> (структура помеченных союзов)
Ссылка на место получения цепочки доверия при проверке сертификата Transport Layer Security (TLS) удалённого узла.
Примечание
Это структура помеченных союзов. Может быть задан только один из следующих ключей верхнего уровня:acm, file, sds.acm -> (структура)
Ссылка на объект, представляющий доверие контекста проверки Transport Layer Security (TLS) для сертификата Certificate Manager.
certificateAuthorityArns -> (список)
Один или несколько ARN Amazon Certificate Manager.
(строка)
file -> (структура)
Объект, представляющий доверие контекста проверки Transport Layer Security (TLS) для локального файла.
certificateChain -> (строка)
sds -> (структура)
Ссылка на объект, представляющий доверие Secret Discovery Service для контекста проверки Transport Layer Security (TLS) виртуального шлюза.
secretName -> (строка)
listeners -> (список)
Слушатели, от которых ожидается получение входящего трафика узлом сети. Вы можете указать один слушатель.
(структура)
Объект, представляющий слушателя виртуального шлюза.
connectionPool -> (структура помеченных союзов)
Информация о пуле подключений для слушателя виртуального шлюза.
Примечание
Это структура помеченных союзов. Может быть задан только один из следующих ключей верхнего уровня:grpc, http, http2.grpc -> (структура)
Объект, представляющий тип пула подключений.
maxRequests -> (целое число)
http -> (структура)
Объект, представляющий тип пула подключений.
maxConnections -> (целое число)
maxPendingRequests -> (целое число)
max_connections, которые Envoy будет помещать в очередь для кластера upstream.http2 -> (структура)
Объект, представляющий тип пула подключений.
maxRequests -> (целое число)
healthCheck -> (структура)
Информация о проверке работоспособности для слушателя.
healthyThreshold -> (целое число)
intervalMillis -> (длинное целое число)
path -> (строка)
port -> (целое число)
protocol -> (строка)
grpc, то ваш сервис должен соответствовать протоколу проверки работоспособности GRPC.timeoutMillis -> (длинное целое число)
unhealthyThreshold -> (целое число)
portMapping -> (структура)
Информация о сопоставлении портов для слушателя.
port -> (целое число)
protocol -> (строка)
tls -> (структура)
Ссылка на объект, представляющий свойства Transport Layer Security (TLS) для слушателя.
certificate -> (структура помеченных союзов)
Объект, представляющий сертификат Transport Layer Security (TLS).
Примечание
Это структура помеченных союзов. Может быть задан только один из следующих ключей верхнего уровня:acm, file, sds.acm -> (структура)
Ссылка на объект, представляющий сертификат Certificate Manager.
certificateArn -> (строка)
file -> (структура)
Ссылка на объект, представляющий сертификат локального файла.
certificateChain -> (строка)
privateKey -> (строка)
sds -> (структура)
Ссылка на объект, представляющий сертификат Secret Discovery Service слушателя виртуального шлюза.
secretName -> (строка)
mode -> (строка)
Укажите один из следующих режимов.
- STRICT — Слушатель принимает только подключения с включённым TLS.
- PERMISSIVE — Слушатель принимает подключения с включённым или выключенным TLS.
- DISABLED — Слушатель принимает только подключения без TLS.
validation -> (структура)
Ссылка на объект, представляющий контекст проверки Transport Layer Security (TLS) слушателя виртуального шлюза.
subjectAlternativeNames -> (структура)
Ссылка на объект, представляющий SAN для контекста проверки Transport Layer Security (TLS) слушателя виртуального шлюза.
match -> (структура)
Объект, представляющий критерии для определения соответствия SAN.
exact -> (список)
Отправленные значения должны точно совпадать с указанными значениями.
(строка)
trust -> (структура помеченных союзов)
Ссылка на место получения цепочки доверия при проверке сертификата Transport Layer Security (TLS) удалённого узла.
Примечание
Это структура помеченных союзов. Может быть задан только один из следующих ключей верхнего уровня:file, sds.file -> (структура)
Объект, представляющий доверие контекста проверки Transport Layer Security (TLS) для локального файла.
certificateChain -> (строка)
sds -> (структура)
Ссылка на объект, представляющий доверие Secret Discovery Service для контекста проверки Transport Layer Security (TLS) слушателя виртуального шлюза.
secretName -> (строка)
logging -> (структура)
Объект, представляющий информацию о регистрации.
accessLog -> (структура помеченных союзов)
Настройка журнала доступа.
Примечание
Это структура помеченных союзов. Только один из следующих ключей верхнего уровня может быть задан:file.file -> (структура)
Объект файла, в который будут отправляться журналы доступа виртуального шлюза.
format -> (структура помеченных союзов)
Указанный формат журналов доступа виртуального шлюза. Он может быть либо json_format, либо text_format.
Примечание
Это структура помеченных союзов. Только один из следующих ключей верхнего уровня может быть задан:json, text.json -> (список)
(структура)
Объект, представляющий пары ключ-значение для JSON.
key -> (строка)
value -> (строка)
text -> (строка)
path -> (строка)
/dev/stdout, чтобы отправлять журналы доступа в стандартный вывод и настроить контейнер Envoy на использование драйвера журналов, например, awslogs, для экспорта журналов доступа в службу хранения журналов, такую как Amazon CloudWatch Logs. Вы также можете указать путь в файловой системе контейнера Envoy для записи файлов на диск.status -> (структура)
Текущий статус виртуального шлюза.
status -> (строка)
virtualGatewayName -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.