Spec-Zone.ru › AWS CLI v2

[ aws . docdb-elastic ]

копировать-снэпшот-кластера

Описание

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

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

Синтаксис

  copy-cluster-snapshot
[--copy-tags | --no-copy-tags]
[--kms-key-id <value>]
--snapshot-arn <value>
[--tags <value>]
--target-snapshot-name <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]

Параметры

--copy-tags | --no-copy-tags (boolean)

Установите в true, чтобы скопировать все теги из исходного снимка кластера в целевой снимок эластичного кластера. По умолчанию значение false.

--kms-key-id (string)

Идентификатор ключа KMS Amazon Web Services для зашифрованного снимка эластичного кластера. Идентификатор ключа KMS Amazon Web Services — это Amazon Resource Name (ARN), идентификатор ключа KMS Amazon Web Services или псевдоним ключа KMS Amazon Web Services для ключа шифрования KMS Amazon Web Services.

Если вы копируете зашифрованный снимок эластичного кластера из своей учетной записи Amazon Web Services, вы можете указать значение для KmsKeyId, чтобы зашифровать копию с помощью нового ключа шифрования KMS Amazon Web Services. Если вы не укажете значение для KmsKeyId, то копия снимка эластичного кластера зашифруется с тем же ключом KMS AWS, что и исходный снимок эластичного кластера.

Чтобы скопировать зашифрованный снимок эластичного кластера в другую область Amazon Web Services, установите KmsKeyId в идентификатор ключа KMS Amazon Web Services, который вы хотите использовать для шифрования копии снимка эластичного кластера в целевой области. Ключи шифрования KMS Amazon Web Services специфичны для области Amazon Web Services, в которой они созданы, и вы не можете использовать ключи шифрования из одной области Amazon Web Services в другой.

Если вы копируете незашифрованный снимок эластичного кластера и указываете значение для параметра KmsKeyId, возвращается ошибка.

--snapshot-arn (string)

Идентификатор Amazon Resource Name (ARN) снимка эластичного кластера.

--tags (map)

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

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

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

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

KeyName1=string,KeyName2=string

Синтаксис JSON:

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

--target-snapshot-name (string)

Идентификатор нового снимка эластичного кластера для создания из исходного снимка кластера. Этот параметр не чувствителен к регистру.

Ограничения:

  • Должен содержать от 1 до 63 букв, цифр или дефисов.
  • Первый символ должен быть буквой.
  • Не может заканчиваться дефисом или содержать два дефиса подряд.

Пример: elastic-cluster-snapshot-5

--cli-input-json | --cli-input-yaml (string) Чтение аргументов из предоставленной JSON-строки. JSON-строка соответствует формату, предоставленному в --generate-cli-skeleton. Если на командной строке предоставлены другие аргументы, эти значения переопределят значения, предоставленные JSON. Невозможно передать произвольные двоичные значения с помощью значения, предоставленного JSON, поскольку строка будет взята буквально. Это не может быть указано вместе с --cli-input-yaml.

--generate-cli-skeleton (string) Выводит JSON-скелет в стандартный вывод без отправки запроса API. Если предоставлено без значения или со значением input, выводит пример входного JSON, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, если предоставлено yaml-input, он выведет пример входного YAML, который можно использовать с --cli-input-yaml. Если предоставлено значение output, он проверяет входные данные команды и возвращает пример выходного JSON для этой команды. Сгенерированный JSON-скелет не является стабильным между версиями AWS CLI, и нет гарантий обратной совместимости в сгенерированном JSON-скелете.

Глобальные параметры

--debug (boolean)

Включить отладовую регистрацию.

--endpoint-url (string)

Переопределить URL по умолчанию команды заданным URL.

--no-verify-ssl (boolean)

По умолчанию AWS CLI использует SSL при взаимодействии с AWS-сервисами. Для каждого SSL-соединения AWS CLI будет проверять SSL-сертификаты. Этот параметр переопределяет поведение по умолчанию по проверке SSL-сертификатов.

--no-paginate (boolean)

Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один вызов для первой страницы результатов.

--output (string)

Стиль форматирования вывода команды.

  • json
  • text
  • таблица
  • yaml
  • yaml-поток

--query (string)

Запрос JMESPath для фильтрации данных ответа.

--profile (string)

Использовать определенный профиль из файла учетных данных.

--region (string)

Используемая область. Переопределяет настройки конфигурации/окружения.

--version (string)

Отобразить версию этого инструмента.

--color (string)

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

  • включено
  • выключено
  • автоматически

--no-sign-request (boolean)

Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент предоставлен.

--ca-bundle (string)

Файл с пакетом сертификатов CA для проверки SSL-сертификатов. Переопределяет настройки конфигурации/окружения.

--cli-read-timeout (int)

Максимальное время чтения сокета в секундах. Если значение равно 0, чтение сокета будет выполняться без блокировки и без таймаута. Значение по умолчанию равно 60 секундам.

--cli-connect-timeout (int)

Максимальное время подключения к сокету в секундах. Если значение равно 0, подключение к сокету будет выполняться без блокировки и без таймаута. Значение по умолчанию равно 60 секундам.

--cli-binary-format (string)

Стиль форматирования, используемый для двоичных блоков. Формат по умолчанию — base64. Формат base64 ожидает, что двоичные блоки будут предоставлены в виде закодированной в base64 строки. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI V1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, соответствующего двоичному блоку, fileb:// всегда будет обрабатываться как двоичный и будет использовать содержимое файла непосредственно независимо от настройки cli-binary-format. При использовании file:// содержимое файла должно быть правильно отформатировано для настроенного cli-binary-format.

  • base64
  • raw-в-base64-выход

--no-cli-pager (boolean)

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

--cli-auto-prompt (boolean)

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

--no-cli-auto-prompt (boolean)

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

Вывод

снимок -> (структура)

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

имяАдминистратора -> (строка)

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

clusterArn -> (строка)

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

времяСозданиеКластера -> (строка)

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

kmsKeyId -> (строка)

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

snapshotArn -> (строка)

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

времяСозданиеСнимок -> (строка)

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

имяСнимок -> (строка)

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

типСнимок -> (строка)

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

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

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

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

subnetIds -> (список)

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

(строка)

vpcSecurityGroupIds -> (список)

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

(строка)

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

Spec-Zone.ru

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