create-route

Описание

Создаёт маршрут для API.

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

Синтаксис

  create-route
--api-id <value>
[--api-key-required | --no-api-key-required]
[--authorization-scopes <value>]
[--authorization-type <value>]
[--authorizer-id <value>]
[--model-selection-expression <value>]
[--operation-name <value>]
[--request-models <value>]
[--request-parameters <value>]
--route-key <value>
[--route-response-selection-expression <value>]
[--target <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]

Параметры

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

--api-key-required | --no-api-key-required (логическое значение)

--authorization-scopes (список)

Синтаксис:

"string" "string" ...

--authorization-type (строка)

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

--model-selection-expression (строка)

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

--request-models (словарь)

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

KeyName1=string,KeyName2=string

Синтаксис JSON:

{"string": "string"
  ...}

--request-parameters (словарь)

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

KeyName1=Required=boolean,KeyName2=Required=boolean

Синтаксис JSON:

{"string": {
      "Required": true|false
    }
  ...}

--route-key (строка)

--route-response-selection-expression (строка)

--target (строка)

--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
• table
• yaml
• yaml-stream

--query (строка)

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

--profile (строка)

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

--region (строка)

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

--version (строка)

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

--color (строка)

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

• on
• off
• auto

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

Примеры

Создание маршрута по умолчанию для WebSocket или HTTP API

Следующий create-route пример создаёт маршрут по умолчанию для WebSocket или HTTP API.

aws apigatewayv2 create-route \
    --api-id aabbccddee \
    --route-key '$default'

Вывод:

{
    "ApiKeyRequired": false,
    "AuthorizationType": "NONE",
    "RouteKey": "$default",
    "RouteId": "1122334"
}

Для получения дополнительной информации см. работу с маршрутами для WebSocket API в руководстве разработчика Amazon API Gateway.

Создание маршрута для HTTP API

Следующий create-route пример создаёт маршрут под названием signup, который принимает запросы POST.

aws apigatewayv2 create-route \
    --api-id aabbccddee \
    --route-key 'POST /signup'

Вывод:

{
    "ApiKeyRequired": false,
    "AuthorizationType": "NONE",
    "RouteKey": "POST /signup",
    "RouteId": "1122334"
}

Для получения дополнительной информации см. работу с маршрутами для HTTP API в руководстве разработчика Amazon API Gateway.

Вывод

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

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

AuthorizationScopes -> (список)

AuthorizationType -> (строка)

AuthorizerId -> (строка)

ModelSelectionExpression -> (строка)

OperationName -> (строка)

RequestModels -> (словарь)

RequestParameters -> (словарь)

RouteId -> (строка)

RouteKey -> (строка)

RouteResponseSelectionExpression -> (строка)

Target -> (строка)