Spec-Zone.ru › AWS CLI v2

[ aws . rds ]

describe-option-group-options

Описание

Описывает все доступные параметры для указанного движка.

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

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

Синтаксис

  describe-option-group-options
--engine-name <value>
[--major-engine-version <value>]
[--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-name (строка)

Имя движка, для которого необходимо описать параметры.

Допустимые значения:

  • db2-ae
  • db2-se
  • mariadb
  • mysql
  • oracle-ee
  • oracle-ee-cdb
  • oracle-se2
  • oracle-se2-cdb
  • postgres
  • sqlserver-ee
  • sqlserver-se
  • sqlserver-ex
  • sqlserver-web

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

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

--filters (список)

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

(структура)

Пара имя-значение фильтра, используемая для возврата более конкретного списка результатов из операции describe. Фильтры могут использоваться для сопоставления набора ресурсов по определенным критериям, таким как идентификаторы. Поддерживаемые фильтры операции describe документированы вместе с операцией describe.

Примечание

В настоящее время в фильтрах не поддерживаются подстановочные знаки.

Следующие действия могут быть отфильтрованы:

  • DescribeDBClusterBacktracks
  • DescribeDBClusterEndpoints
  • DescribeDBClusters
  • DescribeDBInstances
  • DescribeDBRecommendations
  • DescribeDBShardGroups
  • DescribePendingMaintenanceActions

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

Имя фильтра. Имена фильтров чувствительны к регистру.

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

Одно или несколько значений фильтра. Значения фильтров чувствительны к регистру.

(строка)

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

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.

Примеры

Примечание

Для использования следующих примеров необходимо установить и настроить AWS CLI. Дополнительную информацию см. в руководстве по началу работы в Руководстве пользователя AWS CLI.

Если не указано иное, все примеры используют правила кавычек, аналогичные unix-подобным. Эти примеры необходимо адаптировать к правилам кавычек вашей командной строки. См. Использование кавычек со строками в Руководстве пользователя AWS CLI.

Для описания всех доступных параметров

Следующий пример describe-option-group-options списка двух параметров для экземпляра базы данных Oracle 19c.

aws rds describe-option-group-options \
    --engine-name oracle-ee \
    --major-engine-version 19 \
    --max-items 2

Вывод:

{
    "OptionGroupOptions": [
        {
            "Name": "APEX",
            "Description": "Oracle Application Express Runtime Environment",
            "EngineName": "oracle-ee",
            "MajorEngineVersion": "19",
            "MinimumRequiredMinorEngineVersion": "0.0.0.ru-2019-07.rur-2019-07.r1",
            "PortRequired": false,
            "OptionsDependedOn": [],
            "OptionsConflictsWith": [],
            "Persistent": false,
            "Permanent": false,
            "RequiresAutoMinorEngineVersionUpgrade": false,
            "VpcOnly": false,
            "SupportsOptionVersionDowngrade": false,
            "OptionGroupOptionSettings": [],
            "OptionGroupOptionVersions": [
                {
                    "Version": "19.1.v1",
                    "IsDefault": true
                },
                {
                    "Version": "19.2.v1",
                    "IsDefault": false
                }
            ]
        },
        {
            "Name": "APEX-DEV",
            "Description": "Oracle Application Express Development Environment",
            "EngineName": "oracle-ee",
            "MajorEngineVersion": "19",
            "MinimumRequiredMinorEngineVersion": "0.0.0.ru-2019-07.rur-2019-07.r1",
            "PortRequired": false,
            "OptionsDependedOn": [
                "APEX"
            ],
            "OptionsConflictsWith": [],
            "Persistent": false,
            "Permanent": false,
            "RequiresAutoMinorEngineVersionUpgrade": false,
            "VpcOnly": false,
            "OptionGroupOptionSettings": []
        }
    ],
    "NextToken": "eyJNYXJrZXIiOiBudWxsLCAiYm90b190cnVuY2F0ZV9hbW91bnQiOiAyfQ=="
}

Дополнительную информацию см. в разделе Перечисление параметров и параметров настроек для группы параметров в Руководстве пользователя Amazon RDS.

Выходные данные

OptionGroupOptions -> (список)

Список доступных опций группы опций.

(структура)

Доступная опция.

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

Имя опции.

Описание -> (строка)

Описание опции.

Имя двигателя -> (строка)

Имя двигателя, к которому может быть применена эта опция.

Основная версия двигателя -> (строка)

Указывает основную версию двигателя, для которой доступна опция.

Минимальная требуемая второстепенная версия двигателя -> (строка)

Минимальная необходимая версия двигателя для применения опции.

Требуется порт -> (логическое значение)

Указывает, требуется ли порт для опции.

Порт по умолчанию -> (целое число)

Если для опции требуется порт, указывает порт по умолчанию для опции.

Зависимые опции -> (список)

Опции, являющиеся предварительными условиями для этой опции.

(строка)

Конфликтующие опции -> (список)

Опции, конфликтующие с этой опцией.

(строка)

Постоянная -> (логическое значение)

Постоянные опции нельзя удалять из группы опций, пока экземпляры БД связаны с группой опций. Если вы разорвете все связи экземпляров БД с группой опций, вы можете удалить постоянную опцию из группы опций.

Постоянная -> (логическое значение)

Постоянные опции никогда нельзя удалять из группы опций. Группу опций, содержащую постоянную опцию, нельзя удалить из экземпляра БД.

Требуется автоматическое обновление второстепенной версии двигателя -> (логическое значение)

Если значение true, необходимо включить параметр Автоматическое обновление второстепенной версии для вашего экземпляра БД, прежде чем использовать эту опцию. Вы можете включить Автоматическое обновление второстепенной версии при первом создании экземпляра БД или позже, изменив свой экземпляр БД.

Только VPC -> (логическое значение)

Если значение true, вы можете использовать эту опцию только с экземпляром БД, который находится в VPC.

Поддерживает понижение версии опций -> (логическое значение)

Если значение true, вы можете изменить опцию на более раннюю версию опции. Это применимо только к опциям, для которых доступны различные версии.

Параметры опции группы опций -> (список)

Доступные параметры настроек (и значения по умолчанию) для каждой опции в группе опций.

(структура)

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

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

Имя параметра группы опций.

Описание параметра -> (строка)

Описание параметра группы опций.

Значение по умолчанию -> (строка)

Значение по умолчанию для параметра группы опций.

Тип применения -> (строка)

Тип параметра специфичный для двигателя БД для параметра группы опций.

Допустимые значения -> (строка)

Указывает допустимые значения для параметра группы опций.

Изменяемый -> (логическое значение)

Указывает, можно ли изменить этот параметр группы опций от значения по умолчанию.

Обязательный -> (логическое значение)

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

Минимальная версия двигателя по допустимому значению -> (список)

Минимальная версия двигателя БД, требуемая для соответствующего допустимого значения для этой настройки опции.

(структура)

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

Допустимое значение -> (строка)

Допустимое значение для параметра настройки опции.

Минимальная версия двигателя -> (строка)

Минимальная версия двигателя БД, требуемая для допустимого значения.

Версии опций группы опций -> (список)

Доступные версии опции.

(структура)

Версия опции. Версии опций группы опций возвращаются действием DescribeOptionGroupOptions.

Версия -> (строка)

Версия опции.

По умолчанию -> (логическое значение)

Указывает, является ли версия опции версией по умолчанию.

Копируемый между аккаунтами -> (логическое значение)

Указывает, можно ли скопировать опцию в другие аккаунты Amazon Web Services.

Маркер -> (строка)

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

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

Spec-Zone.ru

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