Spec-Zone.ru › AWS CLI v2

[ aws . keyspaces ]

create-type

Описание

Операция CreateType создаёт новый пользовательский тип в указанном хранилище ключей.

Для настройки необходимых разрешений, см. Разрешения для создания пользовательского типа в руководстве Amazon Keyspaces Developer Guide.

Для получения дополнительной информации, см. Пользовательские типы (UDTs) в руководстве Amazon Keyspaces Developer Guide.

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

Синтаксис

  create-type
--keyspace-name <value>
--type-name <value>
--field-definitions <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]

Параметры

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

Имя хранилища ключей.

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

Имя пользовательского типа.

Имена UDT должны содержать не более 48 символов, начинаться с буквы и содержать только буквенно-цифровые символы и символы нижнего подчеркивания. Amazon Keyspaces автоматически преобразует символы верхнего регистра в нижний.

В качестве альтернативы можно объявить имя UDT в двойных кавычках. При объявлении имени UDT в двойных кавычках Amazon Keyspaces сохраняет регистр и допускает специальные символы.

Вы также можете использовать двойные кавычки как часть имени при создании UDT, но каждый символ двойной кавычки должен быть экранирован дополнительной двойной кавычкой.

--field-definitions (список)

Определения полей, состоящие из имён и типов, определяющие этот тип.

(структура)

Определение поля состоит из имени и типа.

name -> (строка)

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

type -> (строка)

Любой поддерживаемый тип данных Cassandra, включая коллекции и другие пользовательские типы, которые находятся в том же хранилище ключей.

Для получения дополнительной информации, см. Поддержку типов данных Cassandra в руководстве Amazon Keyspaces Developer Guide.

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

name=string,type=string ...

Синтаксис JSON:

[
  {
    "name": "string",
    "type": "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
  • текст
  • таблица
  • 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.

Вывод

keyspaceArn -> (строка)

Уникальный идентификатор хранилища ключей, содержащего новый тип в формате Amazon Resource Name (ARN).

typeName -> (строка)

Отформатированное имя созданного пользовательского типа. Обратите внимание, что Amazon Keyspaces требует отформатированного имени типа для других операций, например, GetType.

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

Spec-Zone.ru

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