Spec-Zone.ru › AWS CLI v2

[ aws . docdb ]

Переключение глобального кластера

Описание

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

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

Синтаксис

  switchover-global-cluster
--global-cluster-identifier <value>
--target-db-cluster-identifier <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]

Параметры

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

Идентификатор глобального кластера баз данных Amazon DocumentDB, который нужно переключить. Идентификатор — уникальный ключ, назначенный пользователем при создании кластера. Другими словами, это имя глобального кластера. Этот параметр нечувствителен к регистру.

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

  • Должен совпадать с идентификатором существующего глобального кластера (глобальной базы данных Amazon DocumentDB).
  • Минимальная длина 1. Максимальная длина 255.

Шаблон: [A-Za-z][0-9A-Za-z-:._]*

--target-db-cluster-identifier (строка)

Идентификатор вторичного кластера Amazon DocumentDB, который нужно повысить до нового первичного кластера для глобального кластера баз данных. Используйте Amazon Resource Name (ARN) для идентификатора, чтобы Amazon DocumentDB смог найти кластер в своем регионе Amazon Web Services.

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

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

Шаблон: [A-Za-z][0-9A-Za-z-:._]*

--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. Этот идентификатор встречается в записях журналов CloudTrail всякий раз, когда обращается к KMS-ключу (CMK) для кластера.

GlobalClusterArn -> (строка)

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

Status -> (строка)

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

Engine -> (строка)

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

EngineVersion -> (строка)

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

DatabaseName -> (строка)

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

StorageEncrypted -> (логическое значение)

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

DeletionProtection -> (логическое значение)

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

GlobalClusterMembers -> (список)

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

(структура)

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

DBClusterArn -> (строка)

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

Readers -> (список)

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

(строка)

IsWriter -> (логическое значение)

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

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

Spec-Zone.ru

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