получение-параметров-по-умолчанию-для-кластера-с-движком-базы-данных
Описание
Возвращает информацию о параметрах по умолчанию для движка базы данных кластера.
См. также: Документацию API AWS
Синтаксис
describe-engine-default-cluster-parameters
--db-parameter-group-family <value>
[--filters <value>]
[--max-records <value>]
[--marker <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]
Параметры
--db-parameter-group-family (строка)
--filters (список)
Этот параметр в настоящее время не поддерживается.
(структура)
Набор значений фильтра, используемый для возврата более узкого списка результатов. Можно использовать фильтр для сопоставления набора ресурсов по определённым критериям, например, по идентификаторам.
Подстановочные знаки в фильтрах не поддерживаются.
Имя -> (строка)
Значения -> (список)
Одно или несколько значений фильтра. Значения фильтров чувствительны к регистру.
(строка)
Сокращенный синтаксис:
Name=string,Values=string,string ...
Синтаксис JSON:
[
{
"Name": "string",
"Values": ["string", ...]
}
...
]
--max-records (целое число)
Максимальное количество записей для включения в ответ. Если существует больше записей, чем указанное значение MaxRecords, в ответ включается маркер пагинации (метка), чтобы можно было получить оставшиеся результаты.
По умолчанию: 100
Ограничения: минимум 20, максимум 100.
--marker (строка)
MaxRecords.--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.
Примеры
Примечание
Для использования следующих примеров необходимо установить и настроить AWS CLI. Подробнее см. руководство по началу работы в справочнике AWS CLI User Guide.
Если не указано иное, все примеры используют правила цитирования, подобные UNIX. Эти примеры необходимо адаптировать к правилам цитирования вашей терминальной среды. См. Использование кавычек со строками в AWS CLI User Guide.
Для получения информации о параметрах по умолчанию для Amazon DocumentDB
Следующий пример отображает подробности о параметрах по умолчанию для Amazon DocumentDB параметра группы docdb3.6.
aws docdb describe-engine-default-cluster-parameters \
--db-parameter-group-family docdb3.6
Вывод:
{
"EngineDefaults": {
"DBParameterGroupFamily": "docdb3.6",
"Parameters": [
{
"ApplyType": "dynamic",
"ParameterValue": "disabled",
"Description": "Enables auditing on cluster.",
"Source": "system",
"DataType": "string",
"MinimumEngineVersion": "3.6.0",
"AllowedValues": "enabled,disabled",
"ParameterName": "audit_logs",
"IsModifiable": true
},
{
"ApplyType": "static",
"ParameterValue": "enabled",
"Description": "Config to enable/disable TLS",
"Source": "system",
"DataType": "string",
"MinimumEngineVersion": "3.6.0",
"AllowedValues": "disabled,enabled",
"ParameterName": "tls",
"IsModifiable": true
},
{
"ApplyType": "dynamic",
"ParameterValue": "enabled",
"Description": "Enables TTL Monitoring",
"Source": "system",
"DataType": "string",
"MinimumEngineVersion": "3.6.0",
"AllowedValues": "disabled,enabled",
"ParameterName": "ttl_monitor",
"IsModifiable": true
}
]
}
}
Дополнительную информацию см. в разделе DescribeEngineDefaultClusterParameters в Руководстве разработчика Amazon DocumentDB.
Вывод
EngineDefaults -> (структура)
Содержит результат успешного вызова операции DescribeEngineDefaultClusterParameters.
DBParameterGroupFamily -> (строка)
Marker -> (строка)
MaxRecords.Parameters -> (список)
Параметры определенного семейства группы параметров кластера.
(структура)
Подробная информация об отдельном параметре.
ParameterName -> (строка)
ParameterValue -> (строка)
Описание -> (строка)
Источник -> (строка)
Тип применения -> (строка)
Тип данных -> (строка)
Допустимые значения -> (строка)
Можно изменять -> (булево)
true) или нельзя (false) изменить параметр. Некоторые параметры имеют ограничения безопасности или функционирования, которые препятствуют их изменению.Минимальная версия движка -> (строка)
Метод применения -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.