Spec-Zone.ru › AWS CLI v2

[ aws . docdb-elastic ]

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

Описание

Создаёт снимок эластичного кластера.

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

Синтаксис

  create-cluster-snapshot
--cluster-arn <value>
--snapshot-name <value>
[--tags <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 эластичного кластера, для которого требуется создать снимок.

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

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

--tags (массив)

Теги, которые необходимо назначить новому снимку эластичного кластера.

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

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

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

KeyName1=string,KeyName2=string

Синтаксис JSON:

{"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-in-base64-out

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

Отключить вывод страницы CLI.

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

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

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

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

Вывод

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

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

adminUserName -> (строка)

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

clusterArn -> (строка)

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

clusterCreationTime -> (строка)

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

kmsKeyId -> (строка)

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

snapshotArn -> (строка)

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

snapshotCreationTime -> (строка)

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

snapshotName -> (строка)

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

snapshotType -> (строка)

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

  • automated - Возвращает все снимки кластера, которые Amazon DocumentDB автоматически создал для вашего аккаунта Amazon Web Services.
  • manual - Возвращает все снимки кластера, которые вы создали вручную для вашего аккаунта Amazon Web Services.

status -> (строка)

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

subnetIds -> (список)

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

(строка)

vpcSecurityGroupIds -> (список)

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

(строка)

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

Spec-Zone.ru

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