Spec-Zone.ru › AWS CLI v2

[ aws . neptune ]

describe-orderable-db-instance-options

Описание

Возвращает список доступных вариантов настройки экземпляров базы данных для указанного движка.

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

describe-orderable-db-instance-options является постраничной операцией. Для получения всего набора результатов могут потребоваться несколько вызовов API. Вы можете отключить постраничность, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничностью, аргумент --query должен извлекать данные из результатов следующих выражений запросов: OrderableDBInstanceOptions

Синтаксис

  describe-orderable-db-instance-options
--engine <value>
[--engine-version <value>]
[--db-instance-class <value>]
[--license-model <value>]
[--vpc | --no-vpc]
[--filters <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--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]

Параметры

--engine (строка)

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

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

Значение фильтра версии движка. Укажите этот параметр, чтобы отобразить только предложения, соответствующие указанной версии движка.

--db-instance-class (строка)

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

--license-model (строка)

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

--vpc | --no-vpc (логическое значение)

Значение фильтра VPC. Укажите этот параметр, чтобы отобразить только предложения, доступные для VPC или не для VPC.

--filters (список)

В данный момент этот параметр не поддерживается.

(структура)

Этот тип в данный момент не поддерживается.

Имя -> (строка)

В данный момент этот параметр не поддерживается.

Значения -> (список)

В данный момент этот параметр не поддерживается.

(строка)

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

Name=string,Values=string,string ...

Синтаксис JSON:

[
  {
    "Name": "string",
    "Values": ["string", ...]
  }
  ...
]

--cli-input-json | --cli-input-yaml (строка) Читает аргументы из предоставленной строки JSON. Строка JSON соответствует формату, предоставленному --generate-cli-skeleton. Если другие аргументы предоставляются в командной строке, эти значения переопределят значения, предоставленные в формате JSON. Невозможно передавать произвольные двоичные значения, используя значение, предоставленное в формате JSON, так как строка будет интерпретироваться буквально. Это может не быть указано вместе с --cli-input-yaml.

--starting-token (строка)

Маркер для указания, с какой точки начать постраничный вывод. Это NextToken из ранее урезанного ответа.

Примеры использования см. в разделе Постраничный вывод в руководстве пользователя AWS Command Line Interface.

--page-size (целое число)

Размер каждой страницы при вызове в службе AWS. Это не влияет на количество элементов, возвращаемых в выводе команды. Установка меньшего размера страницы приводит к большему количеству вызовов службы AWS, извлекая меньше элементов в каждом вызове. Это может помочь предотвратить таймаут вызовов службы AWS.

Примеры использования см. в разделе Постраничный вывод в руководстве пользователя AWS Command Line Interface.

--max-items (целое число)

Общее количество элементов, которые необходимо вернуть в выводе команды. Если общее количество доступных элементов превышает указанное значение, в выводе команды предоставляется NextToken. Для возобновления постраничного вывода предоставьте значение NextToken в аргументе starting-token последующей команды. Не используйте элемент ответа NextToken напрямую вне AWS CLI.

Примеры использования см. в разделе Постраничный вывод в руководстве пользователя AWS Command Line Interface.

--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-auto-prompt (логическое значение)

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

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

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

Вывод

OrderableDBInstanceOptions -> (список)

Структура OrderableDBInstanceOption, содержащая информацию о доступных вариантах настройки экземпляра базы данных.

(структура)

Содержит список доступных вариантов настройки экземпляра базы данных.

Этот тип данных используется в качестве элемента ответа в действии DescribeOrderableDBInstanceOptions.

Движок -> (строка)

Тип движка экземпляра базы данных.

EngineVersion -> (строка)

Версия движка экземпляра базы данных.

DBInstanceClass -> (строка)

Класс экземпляра базы данных.

LicenseModel -> (строка)

Модель лицензии экземпляра базы данных.

AvailabilityZones -> (список)

Список зон доступности для экземпляра базы данных.

(структура)

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

Имя -> (строка)

Имя зоны доступности.

MultiAZCapable -> (логическое значение)

Указывает, поддерживает ли экземпляр базы данных Multi-AZ.

ReadReplicaCapable -> (логическое значение)

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

Vpc -> (логическое значение)

Указывает, находится ли экземпляр базы данных во VPC.

SupportsStorageEncryption -> (логическое значение)

Указывает, поддерживает ли экземпляр базы данных шифрование хранилища.

StorageType -> (строка)

Не применимо. В Neptune тип хранилища управляется на уровне кластера базы данных.

SupportsIops -> (логическое значение)

Указывает, поддерживает ли экземпляр базы данных выделенные IOPS.

SupportsEnhancedMonitoring -> (логическое значение)

Указывает, поддерживает ли экземпляр базы данных расширенное мониторинг с интервалами от 1 до 60 секунд.

SupportsIAMDatabaseAuthentication -> (логическое значение)

Указывает, поддерживает ли экземпляр базы данных аутентификацию IAM для базы данных.

SupportsPerformanceInsights -> (логическое значение)

(Не поддерживается Neptune)

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

Минимальный размер хранилища для экземпляра базы данных.

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

Максимальный размер хранилища для экземпляра базы данных.

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

Минимальное общее количество выделенных IOPS для экземпляра базы данных.

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

Максимальное общее количество выделенных IOPS для экземпляра базы данных.

MinIopsPerGib -> (вещественное число)

Минимальное количество выделенных IOPS на GiB для экземпляра базы данных.

MaxIopsPerGib -> (вещественное число)

Максимальное количество выделенных IOPS на GiB для экземпляра базы данных.

SupportsGlobalDatabases -> (логическое значение)

Значение, которое указывает, можно ли использовать глобальные базы данных Neptune с определенной комбинацией других атрибутов движка базы данных.

Marker -> (строка)

Необязательный маркер постраничности, предоставленный предыдущим запросом OrderableDBInstanceOptions. Если этот параметр указан, ответ содержит только записи, следующие за маркером, до значения, указанного параметром MaxRecords.

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

Spec-Zone.ru

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