Spec-Zone.ru › AWS CLI v2

[ aws . docdb-elastic ]

stop-cluster

Описание

Останавливает работающий кластер elastic, который указан в clusterArn. Кластер elastic должен быть в состоянии available.

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

Синтаксис

  stop-cluster
--cluster-arn <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]

Параметры

--cluster-arn (строка)

Идентификатор ARN кластера elastic.

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

Включить/отключить цветной вывод.

  • on
  • off
  • auto

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

Вывод

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

Возвращает информацию о конкретном кластере elastic.

adminUserName -> (строка)

Имя администратора кластера elastic.

authType -> (строка)

Тип аутентификации для кластера elastic.

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

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

clusterArn -> (строка)

Идентификатор ARN кластера elastic.

clusterEndpoint -> (строка)

URL, используемый для подключения к кластеру elastic.

clusterName -> (строка)

Имя кластера elastic.

createTime -> (строка)

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

kmsKeyId -> (строка)

Идентификатор ключа KMS, используемый для шифрования кластера elastic.

preferredBackupWindow -> (строка)

Ежедневный интервал времени, в течение которого создаются автоматические резервные копии, если автоматические резервные копии включены, как определено в backupRetentionPeriod.

preferredMaintenanceWindow -> (строка)

Еженедельный интервал времени, в течение которого может происходить техническое обслуживание системы в формате UTC.

Формат : ddd:hh24:mi-ddd:hh24:mi

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

Количество vCPU, назначенных каждому фрагменту кластера elastic. Максимальное значение — 64. Допустимые значения: 2, 4, 8, 16, 32, 64.

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

Количество фрагментов, назначенных кластеру elastic. Максимальное значение — 32.

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

Количество реплицируемых экземпляров, применяемых ко всем фрагментам кластера. Значение shardInstanceCount 1 означает, что есть один экземпляр записи, а все дополнительные экземпляры являются репликами, которые могут использоваться для чтения и повышения доступности.

shards -> (список)

Общее количество фрагментов в кластере.

(структура)

Имя фрагмента.

createTime -> (строка)

Время создания фрагмента в формате UTC.

shardId -> (строка)

Идентификатор фрагмента.

status -> (строка)

Текущий статус фрагмента.

status -> (строка)

Статус кластера elastic.

subnetIds -> (список)

Идентификаторы подсетей Amazon EC2 для кластера elastic.

(строка)

vpcSecurityGroupIds -> (список)

Список EC2 VPC-групп безопасности, связанных с этим кластером elastic.

(строка)

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

Spec-Zone.ru

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