Spec-Zone.ru › AWS CLI v2

[ aws . neptune ]

stop-db-cluster

Описание

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

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

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

Синтаксис

  stop-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 (строка)

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

--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
  • table
  • yaml
  • yaml-stream

--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 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 Identity and Access Management (IAM), связанных с кластером DB. Роли IAM, связанные с кластером DB, предоставляют разрешения для доступа кластера DB к другим службам Amazon от вашего имени.

(структура)

Описывает роль Amazon Identity and Access Management (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 Identity and Access Management (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.

(строка)

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 -> (целое число)

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

DeletionProtection -> (булево)

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

CrossAccountClone -> (булево)

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

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

Время автоматического перезапуска кластера DB.

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

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

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

MinCapacity -> (double)

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

MaxCapacity -> (double)

Максимальное количество единиц емкости Neptune (NCU) для экземпляра базы данных в кластере серверлесс Neptune. Значения 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