Spec-Zone.ru › AWS CLI v2

[ aws . docdb ]

изменение-глобального-кластера

Описание

Изменение параметра Amazon DocumentDB глобального кластера. Можно изменить один или несколько параметров конфигурации (например: защиту от удаления), или идентификатор глобального кластера, указав эти параметры и новые значения в запросе.

Примечание

Данное действие применяется только к кластерам Amazon DocumentDB.

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

Синтаксис

  modify-global-cluster
--global-cluster-identifier <value>
[--new-global-cluster-identifier <value>]
[--deletion-protection | --no-deletion-protection]
[--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]

Параметры

--global-cluster-identifier (строка)

Идентификатор изменяемого глобального кластера. Этот параметр не чувствителен к регистру.

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

  • Должен совпадать с идентификатором существующего глобального кластера.

--new-global-cluster-identifier (строка)

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

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

Пример: my-cluster2

--deletion-protection | --no-deletion-protection (булево)

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

--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.

Вывод

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

Тип данных, представляющий глобальный кластер Amazon DocumentDB.

GlobalClusterIdentifier -> (строка)

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

GlobalClusterResourceId -> (строка)

Уникальный, неизменяемый идентификатор глобального кластера базы данных, относящийся к Amazon Web Services Region. Этот идентификатор можно найти в записях журнала CloudTrail всякий раз, когда используется KMS-ключ главного клиента (CMK) кластера.

GlobalClusterArn -> (строка)

Amazon Resource Name (ARN) для глобального кластера.

Статус -> (строка)

Указывает текущее состояние этого глобального кластера.

Двигатель -> (строка)

Двигатель базы данных Amazon DocumentDB, используемый глобальным кластером.

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

Указывает версию движка базы данных.

Имя базы данных -> (строка)

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

Зашифрованное хранилище -> (булево)

Настройка шифрования хранилища для глобального кластера.

Защита от удаления -> (булево)

Настройка защиты от удаления для нового глобального кластера.

GlobalClusterMembers -> (список)

Список идентификаторов кластеров вторичных кластеров в глобальном кластере. В настоящее время ограничено одним элементом.

(структура)

Структура данных с информацией о всех первичных и вторичных кластерах, связанных с глобальными кластерами Amazon DocumentDB.

DBClusterArn -> (строка)

Amazon Resource Name (ARN) для каждого кластера Amazon DocumentDB.

Читатели -> (список)

Amazon Resource Name (ARN) для каждого вторичного кластера с возможностью чтения, связанного с глобальным кластером Aurora.

(строка)

Является писателем -> (булево)

Указывает, является ли кластер Amazon DocumentDB первичным кластером (то есть имеет возможность чтения и записи) для глобального кластера Amazon DocumentDB, с которым он связан.

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

Spec-Zone.ru

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