Spec-Zone.ru › AWS CLI v2

[ aws . appsync ]

создать-резолвер

Описание

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

Резолвер преобразует входящие запросы в формат, понятный источнику данных, и преобразует ответы источника данных в GraphQL.

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

Синтаксис

  create-resolver
--api-id <value>
--type-name <value>
--field-name <value>
[--data-source-name <value>]
[--request-mapping-template <value>]
[--response-mapping-template <value>]
[--kind <value>]
[--pipeline-config <value>]
[--sync-config <value>]
[--caching-config <value>]
[--max-batch-size <value>]
[--runtime <value>]
[--code <value>]
[--metrics-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]

Параметры

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

Идентификатор GraphQL API, для которого создаётся резолвер.

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

Имя Type.

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

Имя поля, к которому прикрепляется резолвер.

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

Имя источника данных, для которого создаётся резолвер.

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

Шаблон сопоставления для запросов.

Резолвер использует шаблон сопоставления запросов для преобразования выражения GraphQL в формат, понятный источнику данных. Шаблоны сопоставления написаны на языке шаблонов Apache Velocity (VTL).

Шаблоны сопоставления запросов VTL необязательны при использовании источника данных Lambda. Для всех остальных источников данных требуются шаблоны сопоставления запросов и ответов VTL.

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

Шаблон сопоставления для ответов от источника данных.

--kind (строка)

Тип резолвера.

  • UNIT : Тип резолвера UNIT. Тип резолвера UNIT — это тип по умолчанию. Вы можете использовать резолвер UNIT для выполнения запроса GraphQL к одному источнику данных.
  • PIPELINE : Тип резолвера PIPELINE. Вы можете использовать резолвер PIPELINE для вызова ряда объектов Function последовательно. Вы можете использовать резолвер pipeline для выполнения запроса GraphQL к нескольким источникам данных.

Возможные значения:

  • UNIT
  • PIPELINE

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

PipelineConfig.

functions -> (список)

Список объектов Function.

(строка)

Краткая форма записи:

functions=string,string

Синтаксис JSON:

{
  "functions": ["string", ...]
}

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

SyncConfig для резолвера, прикреплённого к версионированному источнику данных.

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"
  }
}

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

Настройка кэширования для резолвера.

ttl -> (целое)

Время жизни (TTL) в секундах для резолвера с активированным кэшированием.

Допустимые значения от 1 до 3600 секунд.

cachingKeys -> (список)

Ключи кэширования для резолвера с активированным кэшированием.

Допустимые значения — записи из карт $context.arguments, $context.source и $context.identity.

(строка)

Краткая форма записи:

ttl=long,cachingKeys=string,string

Синтаксис JSON:

{
  "ttl": long,
  "cachingKeys": ["string", ...]
}

--max-batch-size (целое)

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

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

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

name -> (строка)

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

runtimeVersion -> (строка)

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

Краткая форма записи:

name=string,runtimeVersion=string

Синтаксис JSON:

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

--code (строка)

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

--metrics-config (строка)

Включает или отключает расширенные метрики резолвера для указанных резолверов. Обратите внимание, что metricsConfig не будет использоваться, если значение resolverLevelMetricsBehavior не установлено в PER_RESOLVER_METRICS. Если значение resolverLevelMetricsBehavior установлено в FULL_REQUEST_RESOLVER_METRICS, то metricsConfig будет проигнорировано. Однако вы по-прежнему можете установить его значение.

metricsConfig может быть ENABLED или DISABLED.

Возможные значения:

  • ENABLED
  • DISABLED

--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 для вывода.

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

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

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

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

Вывод

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

Объект Resolver.

typeName -> (строка)

Имя типа разрешителя.

fieldName -> (строка)

Имя поля разрешителя.

dataSourceName -> (строка)

Имя источника данных разрешителя.

resolverArn -> (строка)

Amazon Resource Name (ARN) разрешителя.

requestMappingTemplate -> (строка)

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

responseMappingTemplate -> (строка)

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

kind -> (строка)

Тип разрешителя.

  • UNIT : Тип разрешителя UNIT. Тип разрешителя UNIT является типом разрешителя по умолчанию. Вы можете использовать разрешитель UNIT для выполнения запроса GraphQL к одному источнику данных.
  • PIPELINE : Тип разрешителя PIPELINE. Вы можете использовать разрешитель PIPELINE для вызова серии объектов Function последовательно. Вы можете использовать разрешитель конвейера для выполнения запроса GraphQL к нескольким источникам данных.

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

PipelineConfig.

functions -> (список)

Список объектов Function.

(строка)

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

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

conflictHandler -> (строка)

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

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

conflictDetection -> (строка)

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

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

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

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

lambdaConflictHandlerArn -> (строка)

Amazon Resource Name (ARN) функции Lambda для использования в качестве обработчика конфликтов.

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

Настройка кеширования для разрешителя.

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

Время жизни (TTL) в секундах для разрешителя, у которого включено кеширование.

Допустимые значения: 1–3600 секунд.

cachingKeys -> (список)

Ключи кеширования для разрешителя, у которого включено кеширование.

Допустимые значения: записи из карт $context.arguments, $context.source и $context.identity.

(строка)

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

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

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

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

name -> (строка)

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

runtimeVersion -> (строка)

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

code -> (строка)

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

metricsConfig -> (строка)

Включает или отключает расширенные метрики разрешителя для указанных разрешителей. Обратите внимание, что metricsConfig не будет использоваться, если значение resolverLevelMetricsBehavior не установлено в PER_RESOLVER_METRICS. Если resolverLevelMetricsBehavior установлено в FULL_REQUEST_RESOLVER_METRICS, metricsConfig будет проигнорировано. Однако вы всё равно можете установить его значение.

metricsConfig может быть ENABLED или DISABLED.

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

Spec-Zone.ru

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