Spec-Zone.ru › AWS CLI v2

[ aws . docdb ]

восстановить-параметр-группы-кластера-db

Описание

Изменяет параметры группы параметров кластера на значения по умолчанию. Чтобы сбросить определённые параметры, отправьте список следующих: ParameterName и ApplyMethod . Чтобы сбросить всю группу параметров кластера, укажите параметры DBClusterParameterGroupName и ResetAllParameters.

При сбросе всей группы динамические параметры обновляются немедленно, а статические параметры устанавливаются в pending-reboot, чтобы они вступили в силу при следующей перезагрузке экземпляра базы данных.

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

Синтаксис

  reset-db-cluster-parameter-group
--db-cluster-parameter-group-name <value>
[--reset-all-parameters | --no-reset-all-parameters]
[--parameters <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-cluster-parameter-group-name (строка)

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

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

Значение, которое устанавливается в true для сброса всех параметров в группе параметров кластера до их значений по умолчанию и false в противном случае. Вы не можете использовать этот параметр, если для параметра Parameters указан список имён параметров.

--parameters (список)

Список имён параметров в группе параметров кластера, которые нужно сбросить до значений по умолчанию. Вы не можете использовать этот параметр, если параметр ResetAllParameters установлен в true .

(структура)

Подробная информация об индивидуальном параметре.

ParameterName -> (строка)

Указывает имя параметра.

ParameterValue -> (строка)

Указывает значение параметра.

Description -> (строка)

Предоставляет описание параметра.

Source -> (строка)

Указывает источник значения параметра.

ApplyType -> (строка)

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

DataType -> (строка)

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

AllowedValues -> (строка)

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

IsModifiable -> (булево)

Указывает, можно (true ) или нельзя (false ) изменять параметр. Некоторые параметры имеют связанные с безопасностью или эксплуатацией ограничения, которые не позволяют их изменять.

MinimumEngineVersion -> (строка)

Самая ранняя версия двигателя, к которой может применяться параметр.

ApplyMethod -> (строка)

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

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

ParameterName=string,ParameterValue=string,Description=string,Source=string,ApplyType=string,DataType=string,AllowedValues=string,IsModifiable=boolean,MinimumEngineVersion=string,ApplyMethod=string ...

Синтаксис JSON:

[
  {
    "ParameterName": "string",
    "ParameterValue": "string",
    "Description": "string",
    "Source": "string",
    "ApplyType": "string",
    "DataType": "string",
    "AllowedValues": "string",
    "IsModifiable": true|false,
    "MinimumEngineVersion": "string",
    "ApplyMethod": "immediate"|"pending-reboot"
  }
  ...
]

--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
  • 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 версии 1, и двоичные значения должны быть переданы буквально. При предоставлении содержимого из файла, которое отображается в двоичном блоке 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.

Чтобы сбросить указанное значение параметра до значений по умолчанию в группе параметров Amazon DocumentDB

Следующий reset-db-cluster-parameter-group пример сбрасывает параметр ttl_monitor в группе параметров Amazon DocumentDB custom3-6-param-grp до его значения по умолчанию.

aws docdb reset-db-cluster-parameter-group \
    --db-cluster-parameter-group-name custom3-6-param-grp \
    --parameters ParameterName=ttl_monitor,ApplyMethod=immediate

Вывод:

{
    "DBClusterParameterGroupName": "custom3-6-param-grp"
}

Для получения дополнительной информации см. title в руководстве разработчика Amazon DocumentDB.

Чтобы сбросить заданные или все значения параметров до значений по умолчанию в группе параметров Amazon DocumentDB

Следующий reset-db-cluster-parameter-group пример сбрасывает все параметры в группе параметров Amazon DocumentDB custom3-6-param-grp до их значений по умолчанию.

aws docdb reset-db-cluster-parameter-group \
    --db-cluster-parameter-group-name custom3-6-param-grp \
    --reset-all-parameters

Вывод:

{
    "DBClusterParameterGroupName": "custom3-6-param-grp"
}

Дополнительную информацию см. в разделе Восстановление группы параметров кластера Amazon DocumentDB в руководстве разработчика Amazon DocumentDB.

Вывод

DBClusterParameterGroupName -> (строка)

Имя группы параметров кластера.

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

  • Должно состоять от 1 до 255 букв или цифр.
  • Первый символ должен быть буквой.
  • Не должно оканчиваться на дефис и не должно содержать два дефиса подряд.

Примечание

Это значение хранится в виде строчной строки.

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

Spec-Zone.ru

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