Spec-Zone.ru › AWS CLI v2

[ aws . docdb-elastic ]

восстановление-кластера-из-снимка

Описание

Восстанавливает эластичный кластер из снимка.

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

Синтаксис

  restore-cluster-from-snapshot
--cluster-name <value>
[--kms-key-id <value>]
[--shard-capacity <value>]
[--shard-instance-count <value>]
--snapshot-arn <value>
[--subnet-ids <value>]
[--tags <value>]
[--vpc-security-group-ids <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-name (строка)

Название эластичного кластера.

--kms-key-id (строка)

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

Идентификатор ключа KMS — это Amazon Resource Name (ARN) ключа шифрования KMS. Если вы создаёте кластер с использованием той же учётной записи Amazon, которая владеет этим ключом шифрования KMS, вы можете использовать псевдоним ключа KMS вместо ARN в качестве ключа шифрования KMS.

Если здесь не указан ключ шифрования, Amazon DocumentDB использует ключ шифрования по умолчанию, созданный KMS для вашей учётной записи. У вашей учётной записи есть другой ключ шифрования по умолчанию для каждого региона Amazon.

--shard-capacity (целое число)

Ёмкость каждого фрагмента в новом восстановленном эластичном кластере.

--shard-instance-count (целое число)

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

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

Идентификатор ARN снимка эластичного кластера.

--subnet-ids (список)

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

(строка)

Синтаксис:

"string" "string" ...

--tags (словарь)

Список имён тегов, которые необходимо назначить восстановленному эластичному кластеру, в виде массива пар ключ-значение, где ключ — имя тега, а значение — значение ключа.

ключ -> (строка)

значение -> (строка)

Сокращённый синтаксис:

KeyName1=string,KeyName2=string

JSON-синтаксис:

{"string": "string"
  ...}

--vpc-security-group-ids (список)

Список групп безопасности EC2 VPC для ассоциации с эластичным кластером.

(строка)

Синтаксис:

"string" "string" ...

--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-в-base64-выход

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

Отключить вывод пагинатора командной строки.

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

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

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

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

Вывод

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

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

adminUserName -> (строка)

Имя администратора эластичного кластера.

authType -> (строка)

Тип аутентификации для эластичного кластера.

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

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

clusterArn -> (строка)

Идентификатор ARN эластичного кластера.

clusterEndpoint -> (строка)

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

clusterName -> (строка)

Имя эластичного кластера.

createTime -> (строка)

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

kmsKeyId -> (строка)

Идентификатор ключа KMS для шифрования эластичного кластера.

preferredBackupWindow -> (строка)

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

preferredMaintenanceWindow -> (строка)

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

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

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

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

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

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

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

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

shards -> (список)

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

(структура)

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

createTime -> (строка)

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

shardId -> (строка)

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

status -> (строка)

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

status -> (строка)

Статус эластичного кластера.

subnetIds -> (список)

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

(строка)

vpcSecurityGroupIds -> (список)

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

(строка)

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

Spec-Zone.ru

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