Spec-Zone.ru › AWS CLI v2

[ aws . rds ]

describe-db-engine-versions

Описание

Описывает свойства определенных версий баз данных.

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

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

Синтаксис

  describe-db-engine-versions
[--engine <value>]
[--engine-version <value>]
[--db-parameter-group-family <value>]
[--filters <value>]
[--default-only | --no-default-only]
[--list-supported-character-sets | --no-list-supported-character-sets]
[--list-supported-timezones | --no-list-supported-timezones]
[--include-all | --no-include-all]
[--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 (строка)

Название базы данных для получения подробной информации о версиях.

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

  • aurora-mysql
  • aurora-postgresql
  • custom-oracle-ee
  • custom-oracle-ee-cdb
  • custom-oracle-se2
  • custom-oracle-se2-cdb
  • 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

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

Конкретная версия базы данных для получения подробной информации.

Пример: 5.1.49

--db-parameter-group-family (строка)

Название семейства групп параметров базы данных для получения подробной информации.

Ограничения:

  • При указании, должно соответствовать существующему семейству групп параметров базы данных.

--filters (список)

Фильтр, определяющий одну или несколько версий баз данных для описания.

Поддерживаемые фильтры:

  • db-parameter-group-family - Принимает имена семейств групп параметров. Список результатов включает только информацию о версиях баз данных для этих семейств групп параметров.
  • engine - Принимает имена движков. Список результатов включает только информацию о версиях баз данных для этих движков.
  • engine-mode - Принимает режимы работы баз данных. Список результатов включает только информацию о версиях баз данных для этих режимов работы. Допустимые режимы работы баз данных:
    • global
    • multimaster
    • parallelquery
    • provisioned
    • serverless
  • engine-version - Принимает версии движков. Список результатов включает только информацию о версиях баз данных для этих версий.
  • status - Принимает статусы версий движков. Список результатов включает только информацию о версиях баз данных для этих статусов. Допустимые статусы:
    • available
    • deprecated

(структура)

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

Примечание

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

Можно фильтровать следующие действия:

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

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

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

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

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

(строка)

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

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

Синтаксис JSON:

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

--default-only | --no-default-only (булево)

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

--list-supported-character-sets | --no-list-supported-character-sets (булево)

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

Если этот параметр включен, а запрашиваемый движок поддерживает параметр CharacterSetName для CreateDBInstance , ответ включает список поддерживаемых наборов символов для каждой версии движка.

Для RDS Custom по умолчанию не выводятся поддерживаемые наборы символов. Если этот параметр включить, RDS Custom не возвращает результатов.

--list-supported-timezones | --no-list-supported-timezones (булево)

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

Если этот параметр включен, а запрашиваемый движок поддерживает параметр TimeZone для CreateDBInstance , ответ включает список поддерживаемых часовых поясов для каждой версии движка.

Для RDS Custom по умолчанию не выводятся поддерживаемые часовые пояса. Если этот параметр включить, RDS Custom не возвращает результатов.

--include-all | --no-include-all (булево)

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

--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
  • текст
  • таблица
  • 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.

Примеры

Примечание

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

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

Для описания версий движка БД для движка БД MySQL

Следующий describe-db-engine-versions пример отображает подробности о каждой из версий движка БД для указанного движка БД.

aws rds describe-db-engine-versions \
    --engine mysql

Вывод:

{
    "DBEngineVersions": [
        {
            "Engine": "mysql",
            "EngineVersion": "5.5.46",
            "DBParameterGroupFamily": "mysql5.5",
            "DBEngineDescription": "MySQL Community Edition",
            "DBEngineVersionDescription": "MySQL 5.5.46",
            "ValidUpgradeTarget": [
                {
                    "Engine": "mysql",
                    "EngineVersion": "5.5.53",
                    "Description": "MySQL 5.5.53",
                    "AutoUpgrade": false,
                    "IsMajorVersionUpgrade": false
                },
                {
                    "Engine": "mysql",
                    "EngineVersion": "5.5.54",
                    "Description": "MySQL 5.5.54",
                    "AutoUpgrade": false,
                    "IsMajorVersionUpgrade": false
                },
                {
                    "Engine": "mysql",
                    "EngineVersion": "5.5.57",
                    "Description": "MySQL 5.5.57",
                    "AutoUpgrade": false,
                    "IsMajorVersionUpgrade": false
                },
                ...some output truncated...
            ]
        }

Дополнительную информацию см. в разделе Что такое Amazon Relational Database Service (Amazon RDS)? в Руководстве пользователя Amazon RDS.

Вывод

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

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

DBEngineVersions -> (список)

Список элементов DBEngineVersion.

(структура)

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

Engine -> (строка)

Имя базы данных движка.

EngineVersion -> (строка)

Номер версии базы данных движка.

DBParameterGroupFamily -> (строка)

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

DBEngineDescription -> (строка)

Описание базы данных движка.

DBEngineVersionDescription -> (строка)

Описание версии базы данных движка.

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

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

CharacterSetName -> (строка)

Имя набора символов.

CharacterSetDescription -> (строка)

Описание набора символов.

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

Изображение EC2

ImageId -> (строка)

Значение, указывающее идентификатор AMI.

Status -> (строка)

Значение, указывающее состояние пользовательской версии движка (CEV).

DBEngineMediaType -> (строка)

Значение, указывающее поставщика исходных носителей AMI на основе операции использования. Применимо для RDS Custom для SQL Server.

SupportedCharacterSets -> (список)

Список наборов символов, поддерживаемых этим движком для параметра CharacterSetName операции CreateDBInstance.

(структура)

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

CharacterSetName -> (строка)

Имя набора символов.

CharacterSetDescription -> (строка)

Описание набора символов.

SupportedNcharCharacterSets -> (список)

Список наборов символов, поддерживаемых движком Oracle DB для параметра NcharCharacterSetName операции CreateDBInstance.

(структура)

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

CharacterSetName -> (строка)

Имя набора символов.

CharacterSetDescription -> (строка)

Описание набора символов.

ValidUpgradeTarget -> (список)

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

(структура)

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

Engine -> (строка)

Имя целевого движка базы данных для обновления.

EngineVersion -> (строка)

Номер версии целевого движка базы данных для обновления.

Description -> (строка)

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

AutoUpgrade -> (логическое)

Указывает, применяется ли целевая версия к любым исходным экземплярам БД, для которых параметр AutoMinorVersionUpgrade установлен в значение true.

Этот параметр динамичен и устанавливается RDS.

IsMajorVersionUpgrade -> (логическое)

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

SupportedEngineModes -> (список)

Список поддерживаемых режимов работы движка БД для целевой версии движка.

(строка)

SupportsParallelQuery -> (логическое)

Указывает, можно ли использовать параллельный запрос Aurora с целевой версией движка.

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

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

SupportsBabelfish -> (логическое)

Указывает, можно ли использовать Babelfish для Aurora PostgreSQL с целевой версией движка.

SupportsLimitlessDatabase -> (логическое)

Указывает, поддерживает ли версия движка баз данных Aurora Limitless Database.

SupportsLocalWriteForwarding -> (логическое)

Указывает, поддерживает ли целевая версия движка перенаправление операций записи из экземпляров БД-читателей на экземпляр БД-записывателя в кластере БД. По умолчанию операции записи не разрешены на экземплярах БД-читателей.

Применимо для: только кластеров БД Aurora

SupportsIntegrations -> (логическое)

Указывает, поддерживает ли версия движка БД интеграции нулевого ETL с Amazon Redshift.

SupportedTimezones -> (список)

Список часовых поясов, поддерживаемых этим движком для параметра Timezone действия CreateDBInstance.

(структура)

Часовой пояс, связанный с DBInstance или DBSnapshot. Этот тип данных — элемент ответа на действия DescribeDBInstances, DescribeDBSnapshots и DescribeDBEngineVersions.

TimezoneName -> (строка)

Имя часового пояса.

ExportableLogTypes -> (список)

Типы логов, доступные для экспорта в CloudWatch Logs базой данных движка.

(строка)

SupportsLogExportsToCloudwatchLogs -> (логическое)

Указывает, поддерживает ли версия движка экспорт типов логов, указанных в ExportableLogTypes, в CloudWatch Logs.

SupportsReadReplica -> (логическое)

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

SupportedEngineModes -> (список)

Список поддерживаемых режимов работы движка БД.

(строка)

SupportedFeatureNames -> (список)

Список функций, поддерживаемых движком БД.

Поддерживаемые функции различаются в зависимости от движка БД и версии движка БД.

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

aws rds describe-db-engine-versions --engine <engine_name> --engine-version <engine_version>

Например, чтобы определить поддерживаемые функции для RDS для PostgreSQL версии 13.3 с помощью командной строки, используйте следующую команду:

aws rds describe-db-engine-versions --engine postgres --engine-version 13.3

Поддерживаемые функции перечислены в разделе SupportedFeatureNames в выводе.

(строка)

Status -> (строка)

Статус версии движка БД, либо available, либо deprecated.

SupportsParallelQuery -> (логическое)

Указывает, можно ли использовать параллельный запрос Aurora с определённой версией движка БД.

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

Указывает, можно ли использовать глобальные базы данных Aurora с определенной версией движка БД.

MajorEngineVersion -> (строка)

Основная версия движка CEV.

DatabaseInstallationFilesS3BucketName -> (строка)

Имя ведра Amazon S3, содержащего файлы установки базы данных.

DatabaseInstallationFilesS3Prefix -> (строка)

Директория Amazon S3, содержащая файлы установки базы данных. Если не указано, то не предполагается никакого префикса.

DBEngineVersionArn -> (строка)

ARN пользовательской версии движка.

KMSKeyId -> (строка)

Идентификатор ключа Amazon Web Services KMS для зашифрованного CEV. Этот параметр требуется для RDS Custom, но необязателен для Amazon RDS.

CreateTime -> (отметка времени)

Время создания версии движка БД.

TagList -> (список)

Список тегов.

Дополнительная информация: Маркирование ресурсов Amazon RDS в Руководстве пользователя Amazon RDS или Маркирование ресурсов Amazon Aurora и Amazon RDS в Руководстве пользователя Amazon Aurora.

(структура)

Метаданные, назначенные ресурсу Amazon RDS, представляющие собой пару ключ-значение.

Дополнительная информация: Маркирование ресурсов Amazon RDS в Руководстве пользователя Amazon RDS или Маркирование ресурсов Amazon Aurora и Amazon RDS в Руководстве пользователя Amazon Aurora.

Key -> (строка)

Ключ — это требуемое имя тега. Строковое значение может иметь длину от 1 до 128 символов Юникода и не может начинаться с aws: или rds:. Строка может содержать только набор символов Юникода, цифр, пробелов, «_», «.», «:», «/», «=», «+», «-», «@» (регулярное выражение Java: “^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$”).

Value -> (строка)

Значение — это необязательное значение тега. Строковое значение может иметь длину от 1 до 256 символов Юникода и не может начинаться с aws: или rds:. Строка может содержать только набор символов Юникода, цифр, пробелов, «_», «.», «:», «/», «=», «+», «-», «@» (регулярное выражение Java: “^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$”).

SupportsBabelfish -> (логическое)

Указывает, поддерживает ли версия движка Babelfish для Aurora PostgreSQL.

CustomDBEngineVersionManifest -> (строка)

JSON-строка, перечисляющая файлы установки и параметры, которые RDS Custom использует для создания пользовательской версии движка (CEV). RDS Custom применяет исправления в том порядке, в котором они указаны в манифесте. Вы можете установить Oracle home, Oracle base и UNIX/Linux пользователя и группу, используя параметры установки. Дополнительную информацию см. в JSON-полях в манифесте CEV в Руководстве пользователя Amazon RDS.

SupportsLimitlessDatabase -> (логическое)

Указывает, поддерживает ли версия движка баз данных Aurora Limitless Database.

SupportsCertificateRotationWithoutRestart -> (логическое)

Указывает, поддерживает ли версия движка обновление сертификата сервера без перезагрузки экземпляра БД.

SupportedCACertificateIdentifiers -> (список)

Список поддерживаемых идентификаторов сертификатов CA.

Дополнительную информацию см. в разделе Использование SSL/TLS для шифрования соединения с экземпляром БД в Руководстве пользователя Amazon RDS и Использование SSL/TLS для шифрования соединения с кластером БД в Руководстве пользователя Amazon Aurora.

(строка)

SupportsLocalWriteForwarding -> (логическое)

Указывает, поддерживает ли версия движка перенаправление операций записи из экземпляров БД-читателей на экземпляр БД-записывателя в кластере БД. По умолчанию операции записи не разрешены на экземплярах БД-читателей.

Применимо для: только кластеров БД Aurora

SupportsIntegrations -> (логическое)

Указывает, поддерживает ли версия движка БД интеграции нулевого ETL с Amazon Redshift.

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

Определяет свойства или ограничения Aurora Serverless v2, которые отличаются между версиями движков Aurora. Вы можете проверить значения этого атрибута при принятии решения о том, какую версию Aurora использовать в новом или обновленном кластере БД. Вы также можете извлечь версию существующего кластера БД и проверить, поддерживает ли эта версия определенные функции Aurora Serverless v2 перед попыткой использовать эти функции.

MinCapacity -> (двойное)

Если минимальная емкость составляет 0 ACU, версия движка поддерживает функцию автоматической приостановки/возобновления Aurora Serverless v2.

MaxCapacity -> (двойное)

Указывает максимальный предел емкости Aurora Serverless v2 для определенной версии движка. В зависимости от версии движка максимальная емкость для кластера Aurora Serverless v2 может составлять 256 или 128.

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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