Spec-Zone.ru › AWS CLI v2

[ aws . neptune ]

promote-read-replica-db-cluster

Описание

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

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

Синтаксис

  promote-read-replica-db-cluster
--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]

Параметры

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

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

--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
  • text
  • таблица
  • 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 версии 1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, отображающего двоичный блок, fileb:// всегда будет обрабатываться как двоичный и будет использовать содержимое файла напрямую независимо от настроек cli-binary-format. При использовании file:// содержимое файла должно быть должным образом отформатировано для настроенного cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (логическое)

Отключить кли-постраничник для вывода.

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

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

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

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

Вывод

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

Содержит сведения о кластере Amazon Neptune DB.

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

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

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

AvailabilityZones -> (список)

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

(строка)

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

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

CharacterSetName -> (строка)

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

DatabaseName -> (строка)

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

DBClusterIdentifier -> (строка)

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

DBClusterParameterGroup -> (строка)

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

DBSubnetGroup -> (строка)

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

Status -> (строка)

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

PercentProgress -> (строка)

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

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

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

Endpoint -> (строка)

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

ReaderEndpoint -> (строка)

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

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

MultiAZ -> (булево)

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

Engine -> (строка)

Предоставляет имя СУБД, которое будет использоваться для этого кластера DB.

EngineVersion -> (строка)

Указывает версию СУБД.

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

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

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

Указывает порт, на котором работает СУБД.

MasterUsername -> (строка)

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

DBClusterOptionGroupMemberships -> (список)

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

(структура)

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

DBClusterOptionGroupName -> (строка)

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

Status -> (строка)

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

PreferredBackupWindow -> (строка)

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

PreferredMaintenanceWindow -> (строка)

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

ReplicationSourceIdentifier -> (строка)

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

ReadReplicaIdentifiers -> (список)

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

(строка)

DBClusterMembers -> (список)

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

(структура)

Содержит информацию об экземпляре, входящем в состав кластера DB.

DBInstanceIdentifier -> (строка)

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

IsClusterWriter -> (булево)

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

DBClusterParameterGroupStatus -> (строка)

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

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

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

VpcSecurityGroups -> (список)

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

(структура)

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

VpcSecurityGroupId -> (строка)

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

Status -> (строка)

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

HostedZoneId -> (строка)

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

StorageEncrypted -> (булево)

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

KmsKeyId -> (строка)

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

DbClusterResourceId -> (строка)

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

DBClusterArn -> (строка)

Amazon Resource Name (ARN) кластера DB.

AssociatedRoles -> (список)

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

(структура)

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

RoleArn -> (строка)

Amazon Resource Name (ARN) роли IAM, связанной с кластером DB.

Status -> (строка)

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

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

FeatureName -> (строка)

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

IAMDatabaseAuthenticationEnabled -> (булево)

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

CloneGroupId -> (строка)

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

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

Указывает время создания кластера DB в формате универсального времени координации (UTC).

CopyTagsToSnapshot -> (булево)

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

EnabledCloudwatchLogsExports -> (список)

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

(строка)

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

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

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

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

LogTypesToEnable -> (список)

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

(строка)

LogTypesToDisable -> (список)

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

(строка)

DBClusterIdentifier -> (строка)

Значение DBClusterIdentifier для кластера DB.

IAMDatabaseAuthenticationEnabled -> (булево)

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

EngineVersion -> (строка)

Версия СУБД.

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

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

StorageType -> (строка)

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

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

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

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

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

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

DeletionProtection -> (булево)

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

CrossAccountClone -> (булево)

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

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

Время, в которое кластер DB будет автоматически перезапущен.

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.

Spec-Zone.ru

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