Spec-Zone.ru › AWS CLI v2

[ aws . appsync ]

create-функция

Описание

Создаёт объект Function.

Функция — это многократно используемый элемент. Вы можете использовать несколько функций для составления логики резолвера.

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

Синтаксис

  create-function
--api-id <value>
--name <value>
[--description <value>]
--data-source-name <value>
[--request-mapping-template <value>]
[--response-mapping-template <value>]
[--function-version <value>]
[--sync-config <value>]
[--max-batch-size <value>]
[--runtime <value>]
[--code <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 GraphQL.

--name (строка)

Имя Function. Имя функции необязательно должно быть уникальным.

--description (строка)

Описание Function.

--data-source-name (строка)

Имя Function DataSource.

--request-mapping-template (строка)

Шаблон сопоставления запроса для Function. Функции поддерживают только версию шаблона сопоставления запроса 2018-05-29.

--response-mapping-template (строка)

Шаблон сопоставления ответа Function.

--function-version (строка)

Версия шаблона сопоставления запроса version. В настоящее время поддерживается только значение 2018-05-29. Обратите внимание, что при использовании VTL и шаблонов сопоставления functionVersion обязательна.

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

Описание конфигурации синхронизации для резолвера.

Указывает стратегию обнаружения конфликтов и стратегию разрешения конфликтов, которые будут использоваться при вызове резолвера.

conflictHandler -> (строка)

Стратегия разрешения конфликтов, выполняемая в случае конфликта.

  • OPTIMISTIC_CONCURRENCY : Разрешение конфликтов путём отклонения мутаций, когда версии не совпадают с последней версией на сервере.
  • AUTOMERGE : Разрешение конфликтов с помощью стратегии разрешения конфликтов Automerge.
  • LAMBDA : Разрешение конфликтов с помощью функции Lambda, предоставленной в LambdaConflictHandlerConfig.

conflictDetection -> (строка)

Стратегия обнаружения конфликтов, используемая для этого резолвера.

  • VERSION : Обнаружение конфликтов на основе версий объектов для этого резолвера.
  • NONE : Не обнаруживать конфликты при вызове этого резолвера.

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

LambdaConflictHandlerConfig при конфигурировании LAMBDA в качестве обработчика конфликтов.

lambdaConflictHandlerArn -> (строка)

Идентификатор ресурса Amazon (ARN) функции Lambda, используемой в качестве обработчика конфликтов.

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

conflictHandler=string,conflictDetection=string,lambdaConflictHandlerConfig={lambdaConflictHandlerArn=string}

Синтаксис JSON:

{
  "conflictHandler": "OPTIMISTIC_CONCURRENCY"|"LAMBDA"|"AUTOMERGE"|"NONE",
  "conflictDetection": "VERSION"|"NONE",
  "lambdaConflictHandlerConfig": {
    "lambdaConflictHandlerArn": "string"
  }
}

--max-batch-size (целое число)

Максимальный размер пакетной обработки для резолвера.

--runtime (структура)

Описание среды выполнения, используемой резолвером Amazon Web Services AppSync или функцией Amazon Web Services AppSync. Указывает имя и версию среды выполнения для использования. Обратите внимание, что если среда выполнения указана, также должен быть указан код.

name -> (строка)

Имя используемой среды выполнения. В настоящее время единственное допустимое значение — APPSYNC_JS.

runtimeVersion -> (строка)

Версия используемой среды выполнения. В настоящее время единственная допустимая версия — 1.0.0.

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

name=string,runtimeVersion=string

Синтаксис JSON:

{
  "name": "APPSYNC_JS",
  "runtimeVersion": "string"
}

--code (строка)

Код function, содержащий функции запроса и ответа. При использовании кода необходимо указать runtime. Значение runtime должно быть APPSYNC_JS.

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

Вывод

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

Объект Function.

functionId -> (строка)

Уникальный идентификатор, представляющий объект Function.

functionArn -> (строка)

Идентификатор ресурса Amazon (ARN) объекта Function.

name -> (строка)

Имя объекта Function.

description -> (строка)

Описание Function.

dataSourceName -> (строка)

Имя DataSource.

requestMappingTemplate -> (строка)

Шаблон сопоставления запроса Function. Функции поддерживают только версию шаблона сопоставления запроса 2018-05-29.

responseMappingTemplate -> (строка)

Шаблон сопоставления ответа Function.

functionVersion -> (строка)

Версия шаблона сопоставления запроса. В настоящее время поддерживается только версия шаблона 2018-05-29.

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

Описание конфигурации синхронизации для резолвера.

Указывает стратегию обнаружения конфликтов и стратегию разрешения конфликтов, которые будут использоваться при вызове резолвера.

conflictHandler -> (строка)

Стратегия разрешения конфликтов, выполняемая в случае конфликта.

  • OPTIMISTIC_CONCURRENCY : Разрешение конфликтов путём отклонения мутаций, когда версии не совпадают с последней версией на сервере.
  • AUTOMERGE : Разрешение конфликтов с помощью стратегии разрешения конфликтов Automerge.
  • LAMBDA : Разрешение конфликтов с помощью функции Lambda, предоставленной в LambdaConflictHandlerConfig.

conflictDetection -> (строка)

Стратегия обнаружения конфликтов, используемая для этого резолвера.

  • VERSION : Обнаружение конфликтов на основе версий объектов для этого резолвера.
  • NONE : Не обнаруживать конфликты при вызове этого резолвера.

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

LambdaConflictHandlerConfig при конфигурировании LAMBDA в качестве обработчика конфликтов.

lambdaConflictHandlerArn -> (строка)

Идентификатор ресурса Amazon (ARN) функции Lambda, используемой в качестве обработчика конфликтов.

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

Максимальный размер пакетной обработки для резолвера.

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

Описание среды выполнения, используемой резолвером Amazon Web Services AppSync или функцией Amazon Web Services AppSync. Указывает имя и версию среды выполнения для использования. Обратите внимание, что если среда выполнения указана, также должен быть указан код.

name -> (строка)

Имя используемой среды выполнения. В настоящее время единственное допустимое значение — APPSYNC_JS.

runtimeVersion -> (строка)

Версия используемой среды выполнения. В настоящее время единственная допустимая версия — 1.0.0.

code -> (строка)

Код function, содержащий функции запроса и ответа. При использовании кода необходимо указать runtime. Значение runtime должно быть APPSYNC_JS.

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

Spec-Zone.ru

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