Spec-Zone.ru › AWS CLI v2

[ aws . iotsecuretunneling ]

open-tunnel

Описание

Создаёт новый туннель и возвращает два токена доступа для клиентов, чтобы они могли подключиться к прокси-серверу IoT Secure Tunneling.

Требуется разрешение на доступ к действию OpenTunnel.

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

Синтаксис

  open-tunnel
[--description <value>]
[--tags <value>]
[--destination-config <value>]
[--timeout-config <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]

Параметры

--description (строка)

Краткое текстовое описание туннеля.

--tags (список)

Коллекция метаданных тегов.

(структура)

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

ключ -> (строка)

Ключ тега.

значение -> (строка)

Значение тега.

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

key=string,value=string ...

Синтаксис JSON:

[
  {
    "key": "string",
    "value": "string"
  }
  ...
]

--destination-config (структура)

Конфигурация назначения для запроса OpenTunnel.

thingName -> (строка)

Имя IoT-устройства, к которому вы хотите подключиться.

services -> (список)

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

(строка)

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

thingName=string,services=string,string

Синтаксис JSON:

{
  "thingName": "string",
  "services": ["string", ...]
}

--timeout-config (структура)

Настройка таймаута для туннеля.

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

Максимальное время (в минутах), в течение которого может оставаться открытым туннель. Если не указано, maxLifetimeTimeoutMinutes по умолчанию составляет 720 минут. Допустимые значения от 1 минуты до 12 часов (720 минут)

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

maxLifetimeTimeoutMinutes=integer

Синтаксис JSON:

{
  "maxLifetimeTimeoutMinutes": integer
}

--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 версии 1, и двоичные значения должны быть переданы дословно. При предоставлении содержимого из файла, сопоставленного с двоичным блоком, 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.

Вывод

tunnelId -> (строка)

Уникальный буквенно-цифровой идентификатор туннеля.

tunnelArn -> (строка)

Amazon Resource Name для туннеля.

sourceAccessToken -> (строка)

Токен доступа, который использует локальный прокси источника для подключения к IoT Secure Tunneling.

destinationAccessToken -> (строка)

Токен доступа, который использует локальный прокси назначения для подключения к IoT Secure Tunneling.

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

Spec-Zone.ru

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