Spec-Zone.ru › AWS CLI v2

[ aws . docdb ]

изменение-параметра-группы-кластера-базы-данных

Описание

Изменяет параметры группы параметров кластера. Для изменения более одного параметра отправьте список следующих элементов: ParameterName , ParameterValue и ApplyMethod . Максимальное количество параметров, которые можно изменить в одном запросе, составляет 20.

Примечание

Изменения динамических параметров применяются немедленно. Изменения статических параметров требуют перезагрузки или окна обслуживания перед тем, как изменение вступит в силу.

Предупреждение

После создания группы параметров кластера необходимо подождать не менее 5 минут перед созданием первого кластера, использующего эту группу параметров кластера в качестве параметрической группы по умолчанию. Это позволяет Amazon DocumentDB полностью завершить действие создания, прежде чем группа параметров будет использоваться в качестве параметрической группы по умолчанию для нового кластера. Этот шаг особенно важен для параметров, критически важных при создании параметрической базы данных по умолчанию для кластера, таких как кодировка символов для параметрической базы данных по умолчанию, определенной параметром character_set_database.

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

Синтаксис

  modify-db-cluster-parameter-group
--db-cluster-parameter-group-name <value>
--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 (строка)

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

--parameters (список)

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

(структура)

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

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

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

ЗначениеПараметра -> (строка)

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

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

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

Источник -> (строка)

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

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

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

ТипДанных -> (строка)

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

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

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

МожноИзменять -> (булево)

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

МинимальнаяВерсияДвижка -> (строка)

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

СпособПрименение -> (строка)

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

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

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
  • текст
  • таблица
  • 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 для вывода.

--cli-auto-prompt (булево)

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

--no-cli-auto-prompt (булево)

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

Примеры

Примечание

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

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

Для изменения группы параметров кластера Amazon DocumentDB

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

aws docdb modify-db-cluster-parameter-group \
    --db-cluster-parameter-group-name custom3-6-param-grp \
    --parameters ParameterName=audit_logs,ParameterValue=enabled,ApplyMethod=pending-reboot \
                 ParameterName=ttl_monitor,ParameterValue=enabled,ApplyMethod=pending-reboot

Вывод:

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

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

Вывод

ИмяГруппыПараметровКластера -> (строка)

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

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

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

Примечание

Это значение хранится в нижнем регистре.

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

Spec-Zone.ru

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