Spec-Zone.ru › AWS CLI v2

[ aws . appsync ]

create-data-source

Описание

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

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

Синтаксис

  create-data-source
--api-id <value>
--name <value>
[--description <value>]
--type <value>
[--service-role-arn <value>]
[--dynamodb-config <value>]
[--lambda-config <value>]
[--elasticsearch-config <value>]
[--open-search-service-config <value>]
[--http-config <value>]
[--relational-database-config <value>]
[--event-bridge-config <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 (строка)

Идентификатор API GraphQL для DataSource.

--name (строка)

Наименование DataSource, заданное пользователем.

--description (строка)

Описание DataSource.

--type (строка)

Тип DataSource.

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

  • AWS_LAMBDA
  • AMAZON_DYNAMODB
  • AMAZON_ELASTICSEARCH
  • NONE
  • HTTP
  • RELATIONAL_DATABASE
  • AMAZON_OPENSEARCH_SERVICE
  • AMAZON_EVENTBRIDGE
  • AMAZON_BEDROCK_RUNTIME

--service-role-arn (строка)

Идентификатор роли IAM для источника данных. Система предполагает эту роль при доступе к источнику данных.

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

Настройки Amazon DynamoDB.

tableName -> (строка)

Имя таблицы.

awsRegion -> (строка)

Регион Amazon Web Services.

useCallerCredentials -> (булево)

Установите в TRUE, чтобы использовать учетные данные Amazon Cognito с этим источником данных.

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

DeltaSyncConfig для версионированного источника данных.

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

Количество минут, в течение которых элемент хранится в источнике данных.

deltaSyncTableName -> (строка)

Имя таблицы Delta Sync.

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

Количество минут, в течение которых запись журнала Delta Sync хранится в таблице Delta Sync.

versioned -> (булево)

Установите в TRUE, чтобы использовать обнаружение и разрешение конфликтов с этим источником данных.

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

tableName=string,awsRegion=string,useCallerCredentials=boolean,deltaSyncConfig={baseTableTTL=long,deltaSyncTableName=string,deltaSyncTableTTL=long},versioned=boolean

Синтаксис JSON:

{
  "tableName": "string",
  "awsRegion": "string",
  "useCallerCredentials": true|false,
  "deltaSyncConfig": {
    "baseTableTTL": long,
    "deltaSyncTableName": "string",
    "deltaSyncTableTTL": long
  },
  "versioned": true|false
}

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

Настройки Lambda.

lambdaFunctionArn -> (строка)

Amazon Resource Name (ARN) функции Lambda.

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

lambdaFunctionArn=string

Синтаксис JSON:

{
  "lambdaFunctionArn": "string"
}

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

Настройки Amazon OpenSearch Service.

Начиная с сентября 2021 года, служба Amazon Elasticsearch — это Amazon OpenSearch Service. Эта конфигурация устарела. Для новых источников данных используйте CreateDataSourceRequest$openSearchServiceConfig для создания источника данных OpenSearch.

endpoint -> (строка)

Конечная точка.

awsRegion -> (строка)

Регион Amazon Web Services.

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

endpoint=string,awsRegion=string

Синтаксис JSON:

{
  "endpoint": "string",
  "awsRegion": "string"
}

--open-search-service-config (структура)

Настройки Amazon OpenSearch Service.

endpoint -> (строка)

Конечная точка.

awsRegion -> (строка)

Регион Amazon Web Services.

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

endpoint=string,awsRegion=string

Синтаксис JSON:

{
  "endpoint": "string",
  "awsRegion": "string"
}

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

Настройки конечной точки HTTP.

endpoint -> (строка)

Конечная точка HTTP URL. Можно указать либо доменное имя, либо комбинацию IP-адреса и порта, схема URL должна быть HTTP или HTTPS. Если порт не указан, AppSync использует порт 80 для конечной точки HTTP и порт 443 для конечных точек HTTPS.

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

Настройка авторизации в случае необходимости авторизации на конечной точке HTTP.

authorizationType -> (строка)

Тип авторизации, требуемый конечной точкой HTTP.

  • AWS_IAM : Тип авторизации — версия 4 подписи (SigV4).

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

Настройки Identity and Access Management (IAM).

signingRegion -> (строка)

Регион Amazon Web Services для авторизации IAM.

signingServiceName -> (строка)

Имя службы подписи для авторизации IAM.

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

endpoint=string,authorizationConfig={authorizationType=string,awsIamConfig={signingRegion=string,signingServiceName=string}}

Синтаксис JSON:

{
  "endpoint": "string",
  "authorizationConfig": {
    "authorizationType": "AWS_IAM",
    "awsIamConfig": {
      "signingRegion": "string",
      "signingServiceName": "string"
    }
  }
}

--relational-database-config (структура)

Настройки реляционной базы данных.

relationalDatabaseSourceType -> (строка)

Тип источника для реляционной базы данных.

  • RDS_HTTP_ENDPOINT : Источник реляционной базы данных — конечная точка HTTP Amazon Relational Database Service (Amazon RDS).

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

Настройки конечной точки HTTP Amazon RDS.

awsRegion -> (строка)

Регион Amazon Web Services для конечной точки HTTP Amazon RDS.

dbClusterIdentifier -> (строка)

Amazon Resource Name (ARN) кластера Amazon RDS.

databaseName -> (строка)

Имя логической базы данных.

schema -> (строка)

Имя логической схемы.

awsSecretStoreArn -> (строка)

Amazon Resource Name (ARN) хранилища секретов Amazon Web Services для учетных данных базы данных.

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

relationalDatabaseSourceType=string,rdsHttpEndpointConfig={awsRegion=string,dbClusterIdentifier=string,databaseName=string,schema=string,awsSecretStoreArn=string}

Синтаксис JSON:

{
  "relationalDatabaseSourceType": "RDS_HTTP_ENDPOINT",
  "rdsHttpEndpointConfig": {
    "awsRegion": "string",
    "dbClusterIdentifier": "string",
    "databaseName": "string",
    "schema": "string",
    "awsSecretStoreArn": "string"
  }
}

--event-bridge-config (структура)

Настройки Amazon EventBridge.

eventBusArn -> (строка)

ARN шины событий. Дополнительная информация о шинах событий см. в разделе [Amazon EventBridge event buses](https://docs.aws.amazon.com/eventbridge/latest/userguide/event-buses.html).

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

eventBusArn=string

Синтаксис JSON:

{
  "eventBusArn": "string"
}

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

Включает или отключает расширенные метрики источника данных для указанных источников данных. Обратите внимание, что metricsConfig не будет использоваться, если значение dataSourceLevelMetricsBehavior не установлено в PER_DATA_SOURCE_METRICS . Если значение dataSourceLevelMetricsBehavior установлено в FULL_REQUEST_DATA_SOURCE_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
  • 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.

Вывод

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

Объект DataSource.

dataSourceArn -> (строка)

Amazon Resource Name (ARN) источника данных.

name -> (строка)

Имя источника данных.

description -> (строка)

Описание источника данных.

type -> (строка)

Тип источника данных.

  • AWS_LAMBDA : Источник данных — функция Lambda.
  • AMAZON_DYNAMODB : Источник данных — таблица Amazon DynamoDB.
  • AMAZON_ELASTICSEARCH : Источник данных — домен Amazon OpenSearch Service.
  • AMAZON_OPENSEARCH_SERVICE : Источник данных — домен Amazon OpenSearch Service.
  • AMAZON_EVENTBRIDGE : Источник данных — конфигурация Amazon EventBridge.
  • AMAZON_BEDROCK_RUNTIME : Источник данных — среда выполнения Amazon Bedrock.
  • NONE : Источник данных отсутствует. Используйте этот тип, когда нужно вызвать операцию GraphQL без подключения к источнику данных, например, при выполнении преобразования данных с помощью резолверов или вызова подписки из мутации.
  • HTTP : Источник данных — HTTP-точку входа.
  • RELATIONAL_DATABASE : Источник данных — реляционная база данных.

serviceRoleArn -> (строка)

Amazon Resource Name (ARN) роли службы управления доступом и безопасностью (IAM) для источника данных. Система предполагает эту роль при доступе к источнику данных.

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

Настройки DynamoDB.

tableName -> (строка)

Имя таблицы.

awsRegion -> (строка)

Регион Amazon Web Services.

useCallerCredentials -> (булево)

Установите в TRUE, чтобы использовать учетные данные Amazon Cognito с этим источником данных.

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

DeltaSyncConfig для версиированного источника данных.

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

Количество минут, в течение которых элемент хранится в источнике данных.

deltaSyncTableName -> (строка)

Имя таблицы Delta Sync.

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

Количество минут, в течение которых запись журнала Delta Sync хранится в таблице Delta Sync.

versioned -> (булево)

Установите в TRUE, чтобы использовать обнаружение и разрешение конфликтов с этим источником данных.

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

Настройки Lambda.

lambdaFunctionArn -> (строка)

Amazon Resource Name (ARN) функции Lambda.

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

Настройки Amazon OpenSearch Service.

endpoint -> (строка)

Точка входа.

awsRegion -> (строка)

Регион Amazon Web Services.

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

Настройки Amazon OpenSearch Service.

endpoint -> (строка)

Точка входа.

awsRegion -> (строка)

Регион Amazon Web Services.

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

Настройки HTTP-точки входа.

endpoint -> (строка)

HTTP-адрес URL-точки входа. Можно указать доменное имя или сочетание IP-адреса и порта, при этом схема URL должна быть HTTP или HTTPS. Если порт не указан, AppSync использует порт 80 для HTTP-точки входа и порт 443 для HTTPS-точек входа.

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

Конфигурация авторизации в случае, если HTTP-точка входа требует авторизации.

authorizationType -> (строка)

Требуемый тип авторизации HTTP-точки входа.

  • AWS_IAM : Тип авторизации — версия 4 подписи (SigV4).

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

Настройки управления доступом и безопасностью (IAM).

signingRegion -> (строка)

Регион Amazon Web Services для подписи авторизации IAM.

signingServiceName -> (строка)

Имя службы подписи для авторизации IAM.

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

Настройки реляционной базы данных.

relationalDatabaseSourceType -> (строка)

Тип источника реляционной базы данных.

  • RDS_HTTP_ENDPOINT : Источник реляционной базы данных — HTTP-точка входа Amazon Relational Database Service (Amazon RDS).

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

Настройки HTTP-точки входа Amazon RDS.

awsRegion -> (строка)

Регион Amazon Web Services для HTTP-точки входа Amazon RDS.

dbClusterIdentifier -> (строка)

Amazon Resource Name (ARN) кластера Amazon RDS.

databaseName -> (строка)

Логическое имя базы данных.

schema -> (строка)

Логическое имя схемы.

awsSecretStoreArn -> (строка)

Amazon Resource Name (ARN) хранилища секретов Amazon Web Services для учетных данных базы данных.

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

Настройки Amazon EventBridge.

eventBusArn -> (строка)

ARN шины событий. Дополнительную информацию о шинах событий см. в разделе Amazon EventBridge event buses.

metricsConfig -> (строка)

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

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

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

Spec-Zone.ru

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