Spec-Zone.ru › AWS CLI v2

[ aws . neptune ]

переключение-кластера-БД

Описание

Вызывает переключение для кластера БД.

Переключение для кластера БД повышает один из реплик чтения (только для чтения экземпляров) в кластере БД до статуса основного экземпляра (запись кластера).

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

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

Синтаксис

  failover-db-cluster
[--db-cluster-identifier <value>]
[--target-db-instance-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]

Параметры

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

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

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

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

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

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

Вы должны указать идентификатор экземпляра для реплики чтения в кластере БД. Например, mydbcluster-replica1 .

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

Вывод

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

Содержит сведения о кластере баз данных Amazon Neptune.

Этот тип данных используется в качестве элемента ответа в операции DescribeDBClusters.

AllocatedStorage -> (целое число)

AllocatedStorage всегда возвращает 1, так как размер хранилища кластера баз данных Neptune не фиксирован, а автоматически настраивается по мере необходимости.

AvailabilityZones -> (список)

Предоставляет список доступных зон EC2, в которых можно создавать экземпляры в кластере баз данных.

(строка)

BackupRetentionPeriod -> (целое число)

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

CharacterSetName -> (строка)

Не поддерживается Neptune.

DatabaseName -> (строка)

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

DBClusterIdentifier -> (строка)

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

DBClusterParameterGroup -> (строка)

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

DBSubnetGroup -> (строка)

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

Status -> (строка)

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

PercentProgress -> (строка)

Указывает процент выполнения операции.

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

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

Endpoint -> (строка)

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

ReaderEndpoint -> (строка)

Конечная точка чтения для кластера баз данных. Конечная точка чтения для кластера баз данных распределяет подключения по всем доступным репликам чтения в кластере баз данных. По мере запроса клиентами новых подключений к конечной точке чтения Neptune распределяет запросы подключений между репликами чтения в кластере баз данных. Это может помочь сбалансировать вашу рабочую нагрузку чтения между несколькими репликами чтения в вашем кластере баз данных.

Если происходит сбой, и реплика чтения, к которой вы подключены, повышается до основного экземпляра, ваше соединение прерывается. Чтобы продолжить отправку рабочей нагрузки чтения другим репликам чтения в кластере, вы можете повторно подключиться к конечной точке чтения.

MultiAZ -> (булево)

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

Engine -> (строка)

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

EngineVersion -> (строка)

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

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

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

Port -> (целое число)

Указывает порт, на котором работает движок базы данных.

MasterUsername -> (строка)

Не поддерживается Neptune.

DBClusterOptionGroupMemberships -> (список)

Не поддерживается Neptune.

(структура)

Не поддерживается Neptune.

DBClusterOptionGroupName -> (строка)

Не поддерживается Neptune.

Status -> (строка)

Не поддерживается Neptune.

PreferredBackupWindow -> (строка)

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

PreferredMaintenanceWindow -> (строка)

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

ReplicationSourceIdentifier -> (строка)

Не поддерживается Neptune.

ReadReplicaIdentifiers -> (список)

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

(строка)

DBClusterMembers -> (список)

Предоставляет список экземпляров, составляющих кластер баз данных.

(структура)

Содержит сведения об экземпляре, который является частью кластера баз данных.

DBInstanceIdentifier -> (строка)

Указывает идентификатор экземпляра для этого члена кластера баз данных.

IsClusterWriter -> (булево)

Значение, которое true, если член кластера является основным экземпляром для кластера баз данных, и false в противном случае.

DBClusterParameterGroupStatus -> (строка)

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

PromotionTier -> (целое число)

Значение, которое указывает порядок, в котором реплика чтения повышается до основного экземпляра после сбоя существующего основного экземпляра.

VpcSecurityGroups -> (список)

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

(структура)

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

VpcSecurityGroupId -> (строка)

Имя группы безопасности VPC.

Status -> (строка)

Состояние группы безопасности VPC.

HostedZoneId -> (строка)

Указывает идентификатор, который Amazon Route 53 присваивает при создании зоны размещения.

StorageEncrypted -> (булево)

Указывает, зашифрован ли кластер баз данных.

KmsKeyId -> (строка)

Если StorageEncrypted равно true, идентификатор ключа Amazon KMS для зашифрованного кластера баз данных.

DbClusterResourceId -> (строка)

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

DBClusterArn -> (строка)

Идентификатор ресурса Amazon (ARN) для кластера баз данных.

AssociatedRoles -> (список)

Предоставляет список ролей управления доступом и идентификацией Amazon (IAM), связанных с кластером баз данных. Роли IAM, связанные с кластером баз данных, предоставляют разрешения для доступа к другим службам Amazon от имени кластера баз данных.

(структура)

Описание роли управления доступом и идентификацией Amazon (IAM), связанной с кластером баз данных.

RoleArn -> (строка)

Идентификатор ресурса Amazon (ARN) роли IAM, связанной с кластером баз данных.

Status -> (строка)

Описание состояния связи между ролью IAM и кластером баз данных. Свойство Status возвращает одно из следующих значений:

  • ACTIVE - ARN роли IAM связан с кластером баз данных и может быть использован для доступа к другим службам Amazon от вашего имени.
  • PENDING - ARN роли IAM связывается с кластером баз данных.
  • INVALID - ARN роли IAM связан с кластером баз данных, но кластер баз данных не может принять роль IAM для доступа к другим службам Amazon от вашего имени.

FeatureName -> (строка)

Имя функции, связанной с ролью управления доступом и идентификацией Amazon (IAM). Список поддерживаемых имен функций см. в DescribeDBEngineVersions.

IAMDatabaseAuthenticationEnabled -> (булево)

Истинно, если сопоставление учетных записей Amazon Identity and Access Management (IAM) с учетными записями базы данных включено, и ложно в противном случае.

CloneGroupId -> (строка)

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

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

Указывает время создания кластера баз данных в универсальном скоординированном времени (UTC).

CopyTagsToSnapshot -> (булево)

Если установлено в ``true`` , метки копируются в любой снимок кластера баз данных, который создается.

EnabledCloudwatchLogsExports -> (список)

Список типов журналов, которые этот кластер баз данных настроен на экспорт в CloudWatch Logs. Действительные типы журналов: audit (для публикации аудиторских журналов в CloudWatch) и slowquery (для публикации журналов медленных запросов в CloudWatch). См. Публикация журналов Neptune в Amazon CloudWatch logs.

(строка)

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

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

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

Эта PendingCloudwatchLogsExports структура определяет ожидаемые изменения в том, какие журналы CloudWatch включены, а какие отключены.

LogTypesToEnable -> (список)

Типы журналов, которые в процессе отключения. После отключения эти типы журналов не экспортируются в CloudWatch Logs.

(строка)

LogTypesToDisable -> (список)

Типы журналов, которые в процессе включения. После включения эти типы журналов экспортируются в CloudWatch Logs.

(строка)

DBClusterIdentifier -> (строка)

Значение DBClusterIdentifier для кластера баз данных.

IAMDatabaseAuthenticationEnabled -> (булево)

Значение, указывающее, включено ли сопоставление учетных записей Amazon Web Services Identity and Access Management (IAM) с учетными записями базы данных.

EngineVersion -> (строка)

Версия движка базы данных.

BackupRetentionPeriod -> (целое число)

Количество дней, в течение которых сохраняются автоматические снимки резервных копий базы данных.

StorageType -> (строка)

Ожидаемое изменение типа хранилища для кластера баз данных. Действительные значения:

  • **standard ** – ( по умолчанию ) Настраивает экономичное хранилище базы данных для приложений с умеренным или небольшим использованием ввода-вывода.
  • **iopt1 ** – Включает хранилище с оптимизацией ввода-вывода, предназначенное для удовлетворения потребностей ресурсоемких графических рабочих нагрузок, которые требуют предсказуемой стоимости с низкой задержкой ввода-вывода и постоянной пропускной способностью ввода-вывода. Оптимизированное хранилище ввода-вывода Neptune доступно только начиная с версии движка 1.3.0.0.

AllocatedStorage -> (целое число)

Размер выделенного хранилища в гигабайтах (GiB) для движков баз данных. Для Neptune AllocatedStorage всегда возвращает 1, так как размер хранилища кластера баз данных Neptune не фиксирован, а автоматически настраивается по мере необходимости.

Iops -> (целое число)

Значение предопределенного ввода-вывода в операциях в секунду (IOPS). Это значение используется только для кластеров баз данных Multi-AZ.

DeletionProtection -> (булево)

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

CrossAccountClone -> (булево)

Если установлено в true , кластер баз данных может быть клонирован между учетными записями.

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

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

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

Отображает конфигурацию масштабирования для кластера баз данных Neptune Serverless.

Дополнительную информацию см. в разделе Использование Amazon Neptune Serverless в Руководстве пользователя Amazon Neptune.

MinCapacity -> (double)

Минимальное количество единиц емкости Neptune (NCU) для экземпляра базы данных в кластере Neptune Serverless. Вы можете указывать значения NCU с шагом в половину, например, 8, 8,5, 9 и так далее.

MaxCapacity -> (double)

Максимальное количество единиц емкости Neptune (NCU) для экземпляра базы данных в кластере Neptune Serverless. Вы можете указывать значения NCU с шагом в половину, например, 40, 40,5, 41 и так далее.

GlobalClusterIdentifier -> (string)

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

IOOptimizedNextAllowedModificationTime -> (timestamp)

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

StorageType -> (string)

Тип хранения, используемый кластером базы данных.

Допустимые значения:

  • **standard ** – (по умолчанию) Обеспечивает экономичное хранение базы данных для приложений с умеренным или небольшим использованием ввода-вывода.
  • **iopt1 ** – Включает оптимизированное хранилище ввода-вывода, предназначенное для удовлетворения потребностей ресурсоемких графических рабочих нагрузок, требующих прогнозируемой цены с низкой задержкой ввода-вывода и постоянной пропускной способностью ввода-вывода. Хранилище Neptune с оптимизацией ввода-вывода доступно только начиная с выпуска движка 1.3.0.0.

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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