Spec-Zone.ru › AWS CLI v2

[ aws . amplifybackend ]

создать-бекенд-api

Описание

Создаёт новый ресурс бэкенд API.

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

Синтаксис

  create-backend-api
--app-id <value>
--backend-environment-name <value>
--resource-config <value>
--resource-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]

Параметры

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

Идентификатор приложения.

--backend-environment-name (строка)

Имя среды бэкенда.

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

Настройка ресурса для данного запроса.

AdditionalAuthTypes -> (список)

Дополнительные методы аутентификации, используемые для взаимодействия с вашими моделями данных.

(структура)

Описание типов аутентификации для ваших настроенных моделей данных.

Mode -> (строка)

Описание режима аутентификации.

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

Описание настроек режима аутентификации.

CognitoUserPoolId -> (строка)

Идентификатор пула пользователей Amazon Cognito, если Amazon Cognito использовался в качестве настройки аутентификации для доступа к вашим моделям данных.

Description -> (строка)

Описание ключа API для API_KEY, если он использовался в качестве механизма аутентификации для доступа к вашим моделям данных.

ExpirationTime -> (двойное)

Время истечения срока действия ключа API для API_KEY, если он использовался в качестве механизма аутентификации для доступа к вашим моделям данных.

OpenIDAuthTTL -> (строка)

Время истечения срока действия механизма аутентификации OpenID.

OpenIDClientId -> (строка)

ClientID для openID, если openID использовался в качестве настройки аутентификации для доступа к вашим моделям данных.

OpenIDIatTTL -> (строка)

Время истечения срока действия механизма аутентификации OpenID.

OpenIDIssueURL -> (строка)

URL издателя openID, если openID использовался в качестве настройки аутентификации для доступа к вашим моделям данных.

OpenIDProviderName -> (строка)

Имя поставщика OpenID, если OpenID использовался в качестве механизма аутентификации для доступа к вашим моделям данных.

ApiName -> (строка)

Имя API, используемое для взаимодействия с моделью данных, настроенной в вашем проекте Amplify.

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

Стратегия разрешения конфликтов для ваших данных, хранящихся в моделях данных.

ResolutionStrategy -> (строка)

Стратегия разрешения конфликтов.

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

Типовой режим аутентификации для взаимодействия с настроенными моделями данных в вашем проекте Amplify.

Mode -> (строка)

Описание режима аутентификации.

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

Описание настроек режима аутентификации.

CognitoUserPoolId -> (строка)

Идентификатор пула пользователей Amazon Cognito, если Amazon Cognito использовался в качестве настройки аутентификации для доступа к вашим моделям данных.

Description -> (строка)

Описание ключа API для API_KEY, если он использовался в качестве механизма аутентификации для доступа к вашим моделям данных.

ExpirationTime -> (двойное)

Время истечения срока действия ключа API для API_KEY, если он использовался в качестве механизма аутентификации для доступа к вашим моделям данных.

OpenIDAuthTTL -> (строка)

Время истечения срока действия механизма аутентификации OpenID.

OpenIDClientId -> (строка)

ClientID для openID, если openID использовался в качестве настройки аутентификации для доступа к вашим моделям данных.

OpenIDIatTTL -> (строка)

Время истечения срока действия механизма аутентификации OpenID.

OpenIDIssueURL -> (строка)

URL издателя openID, если openID использовался в качестве настройки аутентификации для доступа к вашим моделям данных.

OpenIDProviderName -> (строка)

Имя поставщика OpenID, если OpenID использовался в качестве механизма аутентификации для доступа к вашим моделям данных.

Service -> (строка)

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

TransformSchema -> (строка)

Определение модели данных в аннотированном преобразовании схемы GraphQL.

Синтаксис JSON:

{
  "AdditionalAuthTypes": [
    {
      "Mode": "API_KEY"|"AWS_IAM"|"AMAZON_COGNITO_USER_POOLS"|"OPENID_CONNECT",
      "Settings": {
        "CognitoUserPoolId": "string",
        "Description": "string",
        "ExpirationTime": double,
        "OpenIDAuthTTL": "string",
        "OpenIDClientId": "string",
        "OpenIDIatTTL": "string",
        "OpenIDIssueURL": "string",
        "OpenIDProviderName": "string"
      }
    }
    ...
  ],
  "ApiName": "string",
  "ConflictResolution": {
    "ResolutionStrategy": "OPTIMISTIC_CONCURRENCY"|"LAMBDA"|"AUTOMERGE"|"NONE"
  },
  "DefaultAuthType": {
    "Mode": "API_KEY"|"AWS_IAM"|"AMAZON_COGNITO_USER_POOLS"|"OPENID_CONNECT",
    "Settings": {
      "CognitoUserPoolId": "string",
      "Description": "string",
      "ExpirationTime": double,
      "OpenIDAuthTTL": "string",
      "OpenIDClientId": "string",
      "OpenIDIatTTL": "string",
      "OpenIDIssueURL": "string",
      "OpenIDProviderName": "string"
    }
  },
  "Service": "string",
  "TransformSchema": "string"
}

--resource-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
  • текст
  • таблица
  • 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-auto-prompt (логическое значение)

Автоматически запрашивать параметры ввода CLI.

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

Отключить автоматическое запрошение параметров ввода CLI.

Вывод

AppId -> (строка)

Идентификатор приложения.

BackendEnvironmentName -> (строка)

Имя среды бэкенда.

Error -> (строка)

Если запрос завершился ошибкой, возвращается эта ошибка.

JobId -> (строка)

Идентификатор задачи.

Operation -> (строка)

Имя операции.

Status -> (строка)

Текущий статус запроса.

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

Spec-Zone.ru

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