Spec-Zone.ru › AWS CLI v2

[ aws . dsql ]

обновить-кластер

Описание

API UpdateCluster позволяет изменять конфигурации кластеров как в одной, так и в нескольких зонах доступности. С параметром multiRegionProperties можно добавлять или изменять поддержку свидетельских зон доступности и управлять отношениями между узлами кластеров в других зонах доступности.

Примечание

Обратите внимание, что обновление кластеров в нескольких зонах доступности требует дополнительных разрешений IAM, помимо тех, которые необходимы для стандартных обновлений кластера, как подробно описано в разделе Разрешения.

Требуемые разрешения

dsql:UpdateCluster

Разрешение на обновление кластера DSQL.

Ресурсы: ``arn:aws:dsql:region :account-id :cluster/cluster-id ``

dsql:PutMultiRegionProperties

Разрешение на настройку свойств кластера в нескольких зонах доступности.

Ресурсы: ``arn:aws:dsql:region :account-id :cluster/cluster-id ``

dsql:GetCluster

Разрешение на получение информации о кластере.

Ресурсы: ``arn:aws:dsql:region :account-id :cluster/cluster-id ``

dsql:AddPeerCluster

Разрешение на добавление узлов-партнеров.

Ресурсы:

  • Локальный кластер: ``arn:aws:dsql:region :account-id :cluster/cluster-id ``

  • Каждый узел-партнер: точный ARN каждого указанного узла-партнера

    dsql:RemovePeerCluster

Разрешение на удаление узлов-партнеров. Разрешение dsql:RemovePeerCluster использует шаблон ARN с подстановкой, чтобы упростить управление разрешениями во время обновлений.

Ресурсы: arn:aws:dsql:*:*account-id* :cluster/*

dsql:PutWitnessRegion

Разрешение на установку свидетельской зоны доступности.

Ресурсы: ``arn:aws:dsql:region :account-id :cluster/cluster-id ``

Ключи условий: dsql:WitnessRegion (соответствующий указанной свидетельской зоне доступности)

Это разрешение проверяется как в зоне доступности кластера, так и в свидетельской зоне доступности.

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

  • Указанная свидетельская зона доступности в multiRegionProperties.witnessRegion не может совпадать с зоной доступности кластера.
  • При обновлении кластеров с отношениями между узлами разрешения проверяются как для добавления, так и для удаления узлов-партнеров.
  • Разрешение dsql:RemovePeerCluster использует шаблон ARN с подстановкой, чтобы упростить управление разрешениями во время обновлений.

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

Синтаксис

  update-cluster
--identifier <value>
[--deletion-protection-enabled | --no-deletion-protection-enabled]
[--kms-encryption-key <value>]
[--client-token <value>]
[--multi-region-properties <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]

Параметры

--identifier (строка)

Идентификатор кластера, который требуется обновить.

--deletion-protection-enabled | --no-deletion-protection-enabled (логическое значение)

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

--kms-encryption-key (строка)

Ключ KMS, который шифрует и защищает данные в кластере. Вы можете указать ARN, ID или псевдоним существующего ключа или попросить Amazon Web Services создать для вас ключ по умолчанию.

--client-token (строка)

Уникальный, чувствительный к регистру идентификатор, который вы предоставляете для обеспечения идемпотентности запроса. Идемпотентность гарантирует, что запрос API выполняется только один раз. При идемпотентном запросе, если исходный запрос завершается успешно, последующие повторы с тем же маркером клиента возвращают результат исходного успешного запроса и не оказывают дополнительного влияния.

Если вы не укажете маркер клиента, Amazon Web Services автоматически сгенерирует его.

--multi-region-properties (структура)

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

witnessRegion -> (строка)

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

clusters -> (список)

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

(строка)

Amazon Resource Name кластера.

Краткая запись синтаксиса:

witnessRegion=string,clusters=string,string

JSON-синтаксис:

{
  "witnessRegion": "string",
  "clusters": ["string", ...]
}

--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 (логическое значение)

Отключить вывод AWS CLI.

--cli-auto-prompt (логическое значение)

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

--no-cli-auto-prompt (логическое значение)

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

Вывод

identifier -> (строка)

Идентификатор обновляемого кластера.

arn -> (строка)

ARN обновленного кластера.

status -> (строка)

Статус обновленного кластера.

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

Время создания кластера.

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

Spec-Zone.ru

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