Spec-Zone.ru › AWS CLI v2

[ aws . opensearch ]

add-direct-query-data-source

Описание

Добавляет новый источник данных в Amazon OpenSearch Service, чтобы вы могли выполнять прямые запросы к внешним данным.

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

Синтаксис

  add-direct-query-data-source
--data-source-name <value>
--data-source-type <value>
[--description <value>]
--open-search-arns <value>
[--tag-list <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]

Параметры

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

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

--data-source-type (структура помеченного объединения)

Поддерживаемая служба Amazon Web Services, которую вы хотите использовать в качестве источника для прямых запросов в OpenSearch Service.

Примечание

Это структура помеченного объединения. Можно установить только один из следующих верхнеуровневых ключей: CloudWatchLog, SecurityLake.

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

Указывает CloudWatch Logs как тип источника данных для прямых запросов.

RoleArn -> (строка)

Уникальный идентификатор роли IAM, предоставляющей OpenSearch Service разрешения на доступ к указанному источнику данных.

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

Указывает Security Lake как тип источника данных для прямых запросов.

RoleArn -> (строка)

Уникальный идентификатор роли IAM, предоставляющей OpenSearch Service разрешения на доступ к указанному источнику данных.

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

CloudWatchLog={RoleArn=string},SecurityLake={RoleArn=string}

Синтаксис JSON:

{
  "CloudWatchLog": {
    "RoleArn": "string"
  },
  "SecurityLake": {
    "RoleArn": "string"
  }
}

--description (строка)

Необязательное текстовое поле для предоставления дополнительного контекста и подробностей об источнике данных.

--open-search-arns (список)

Список Amazon Resource Names (ARN) для коллекций OpenSearch, связанных с источником данных прямых запросов.

(строка)

Amazon Resource Name (ARN) домена. См. Идентификаторы для сущностей IAM в Использование Amazon Web Services Identity and Access Management для получения дополнительной информации.

Синтаксис:

"string" "string" ...

--tag-list (список)

Список тегов, прикреплённых к домену.

(структура)

Тег (пара ключ-значение) для ресурса Amazon OpenSearch Service.

Key -> (строка)

Ключ тега. Ключи тегов должны быть уникальными для домена, к которому они прикреплены.

Value -> (строка)

Значение, присвоенное соответствующему ключу тега. Значения тегов могут быть null и не обязательно должны быть уникальными в наборе тегов. Например, вы можете иметь пару ключ-значение в наборе тегов project : Trinity и cost-center : Trinity

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

Key=string,Value=string ...

Синтаксис JSON:

[
  {
    "Key": "string",
    "Value": "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
  • table
  • yaml
  • yaml-stream

--query (строка)

Запрос JMESPath для использования при фильтрации данных ответа.

--profile (строка)

Использовать определённый профиль из файла учетных данных.

--region (строка)

Регион для использования. Переопределяет настройки конфигурации/среды.

--version (строка)

Отобразить версию этого инструмента.

--color (строка)

Включить/выключить цветной вывод.

  • on
  • off
  • auto

--no-sign-request (логическое)

Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент предоставлен.

--ca-bundle (строка)

Файл сертификата корневого центра сертификации для использования при проверке 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.

Вывод

DataSourceArn -> (строка)

Уникальный, сгенерированный системой идентификатор, представляющий источник данных.

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

Spec-Zone.ru

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