создание-этапа

Описание

Создаёт этап для API.

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

Синтаксис

  create-stage
[--access-log-settings <value>]
--api-id <value>
[--auto-deploy | --no-auto-deploy]
[--client-certificate-id <value>]
[--default-route-settings <value>]
[--deployment-id <value>]
[--description <value>]
[--route-settings <value>]
--stage-name <value>
[--stage-variables <value>]
[--tags <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]

Параметры

--access-log-settings (структура)

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

DestinationArn=string,Format=string

Синтаксис JSON:

{
  "DestinationArn": "string",
  "Format": "string"
}

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

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

--client-certificate-id (строка)

--default-route-settings (структура)

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

DataTraceEnabled=boolean,DetailedMetricsEnabled=boolean,LoggingLevel=string,ThrottlingBurstLimit=integer,ThrottlingRateLimit=double

Синтаксис JSON:

{
  "DataTraceEnabled": true|false,
  "DetailedMetricsEnabled": true|false,
  "LoggingLevel": "ERROR"|"INFO"|"OFF",
  "ThrottlingBurstLimit": integer,
  "ThrottlingRateLimit": double
}

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

--description (строка)

--route-settings (массив)

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

KeyName1=DataTraceEnabled=boolean,DetailedMetricsEnabled=boolean,LoggingLevel=string,ThrottlingBurstLimit=integer,ThrottlingRateLimit=double,KeyName2=DataTraceEnabled=boolean,DetailedMetricsEnabled=boolean,LoggingLevel=string,ThrottlingBurstLimit=integer,ThrottlingRateLimit=double

Синтаксис JSON:

{"string": {
      "DataTraceEnabled": true|false,
      "DetailedMetricsEnabled": true|false,
      "LoggingLevel": "ERROR"|"INFO"|"OFF",
      "ThrottlingBurstLimit": integer,
      "ThrottlingRateLimit": double
    }
  ...}

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

--stage-variables (массив)

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

KeyName1=string,KeyName2=string

Синтаксис JSON:

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

--tags (массив)

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

KeyName1=string,KeyName2=string

Синтаксис JSON:

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

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

Примеры

Создание этапа

Следующий create-stage пример создаёт этап с именем dev для API.

aws apigatewayv2 create-stage \
    --api-id a1b2c3d4 \
    --stage-name dev

Вывод:

{
    "CreatedDate": "2020-04-06T23:23:46Z",
    "DefaultRouteSettings": {
        "DetailedMetricsEnabled": false
    },
    "LastUpdatedDate": "2020-04-06T23:23:46Z",
    "RouteSettings": {},
    "StageName": "dev",
    "StageVariables": {},
    "Tags": {}
}

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

Вывод

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

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

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

ClientCertificateId -> (строка)

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

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

DeploymentId -> (строка)

Description -> (строка)

LastDeploymentStatusMessage -> (строка)

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

RouteSettings -> (массив)

StageName -> (строка)

StageVariables -> (массив)

Tags -> (массив)