copy-db-cluster-snapshot

Описание

Копирует моментальный снимок кластера.

Для копирования моментального снимка кластера из общего ручного моментального снимка кластера, SourceDBClusterSnapshotIdentifier должно быть Amazon Resource Name (ARN) общего моментального снимка кластера. Вы можете скопировать только общий моментальный снимок DB-кластера, зашифрованный или нет, в той же области Amazon Web Services.

Чтобы отменить операцию копирования после ее начала, удалите целевой моментальный снимок кластера, определенный TargetDBClusterSnapshotIdentifier, пока этот моментальный снимок кластера находится в состоянии копирования.

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

Синтаксис

  copy-db-cluster-snapshot
--source-db-cluster-snapshot-identifier <value>
--target-db-cluster-snapshot-identifier <value>
[--kms-key-id <value>]
[--pre-signed-url <value>]
[--copy-tags | --no-copy-tags]
[--tags <value>]
[--source-region <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]

Параметры

--source-db-cluster-snapshot-identifier (строка)

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

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

Должен указать действительный системный моментальный снимок в состоянии доступен.
Если исходный моментальный снимок находится в той же области Amazon Web Services, что и копия, укажите действительный идентификатор моментального снимка.
Если исходный моментальный снимок находится в другой области Amazon Web Services, чем копия, укажите действительный ARN моментального снимка кластера.

Пример: my-cluster-snapshot1

--target-db-cluster-snapshot-identifier (строка)

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

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

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

Пример: my-cluster-snapshot2

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

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

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

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

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

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

--pre-signed-url (строка)

URL, содержащий подписанный запрос версии 4 подписи для действия API ``CopyDBClusterSnapshot`` в области Amazon Web Services, содержащей копируемый исходный моментальный снимок кластера. Вы должны использовать параметр PreSignedUrl при копировании моментального снимка кластера из другой области Amazon Web Services.

Если вы используете инструмент Amazon Web Services SDK или командную строку, вы можете указать SourceRegion (или --source-region для командной строки) вместо ручного указания PreSignedUrl. Указание SourceRegion автоматически генерирует предварительно подписанный URL, который является допустимым запросом для операции, которую можно выполнить в исходной области Amazon Web Services.

Предварительно подписанный URL должен быть допустимым запросом для действия API CopyDBClusterSnapshot, которое можно выполнить в исходной области Amazon Web Services, содержащей копируемый моментальный снимок кластера. Запрос предварительно подписанного URL должен содержать следующие значения параметров:

SourceRegion — Идентификатор области, содержащей копируемый моментальный снимок.
SourceDBClusterSnapshotIdentifier — Идентификатор шифрованного моментального снимка кластера для копирования. Этот идентификатор должен быть в формате Amazon Resource Name (ARN) для исходной области Amazon Web Services. Например, если вы копируете зашифрованный моментальный снимок кластера из области Amazon Web Services us-east-1, то ваш SourceDBClusterSnapshotIdentifier выглядит примерно так: arn:aws:rds:us-east-1:12345678012:sample-cluster:sample-cluster-snapshot.
TargetDBClusterSnapshotIdentifier — Идентификатор нового моментального снимка кластера для создания. Этот параметр нечувствителен к регистру.

--copy-tags | --no-copy-tags (логическое значение)

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

--tags (список)

Метки, которые нужно назначить моментальному снимку кластера.

(структура)

Метаданные, назначенные ресурсу Amazon DocumentDB, состоящие из пары ключ-значение.

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

Требуемое имя метки. Строковое значение может иметь длину от 1 до 128 символов Юникода и не может начинаться с «aws: » или «rds: ». Строка может содержать только набор символов Юникода, цифр, пробелов, ‘_’, ‘.’, ‘/’, ‘=’, ‘+’, ‘-’ (регулярное выражение Java: «^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$»).

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

Необязательное значение метки. Строковое значение может иметь длину от 1 до 256 символов Юникода и не может начинаться с «aws: » или «rds: ». Строка может содержать только набор символов Юникода, цифр, пробелов, ‘_’, ‘.’, ‘/’, ‘=’, ‘+’, ‘-’ (регулярное выражение Java: «^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$»).

Краткая синтаксическая запись:

Key=string,Value=string ...

Синтаксис JSON:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--source-region (строка)

Идентификатор региона, содержащего копируемый моментальный снимок.

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

Примеры

Примечание

Для использования следующих примеров необходимо установить и настроить AWS CLI. См. руководство по началу работы в руководстве пользователя AWS CLI для получения дополнительной информации.

Если не указано иное, все примеры имеют правила цитирования Unix-подобных. Эти примеры необходимо адаптировать к правилам цитирования вашей оболочки. См. использование кавычек со строками в руководстве пользователя AWS CLI.

Для создания копии моментального снимка

Следующий copy-db-cluster-snapshot пример создает копию sample-cluster-snapshot с именем sample-cluster-snapshot-copy. Копия содержит все метки оригинала плюс новую метку с именем ключа CopyNumber.

aws docdb copy-db-cluster-snapshot \
    --source-db-cluster-snapshot-identifier sample-cluster-snapshot \
    --target-db-cluster-snapshot-identifier sample-cluster-snapshot-copy \
    --copy-tags \
    --tags Key="CopyNumber",Value="1"

Эта команда не генерирует выходных данных.

Для получения дополнительной информации см. копирование моментального снимка кластера в руководстве разработчика Amazon DocumentDB.

Вывод

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

Подробная информация о снимке кластера.

AvailabilityZones -> (список)

Предоставляет список зон доступности Amazon EC2, в которых можно восстановить экземпляры в снимке кластера.

(строка)

DBClusterSnapshotIdentifier -> (строка)

Указывает идентификатор снимка кластера.

DBClusterIdentifier -> (строка)

Указывает идентификатор кластера, из которого был создан этот снимок кластера.

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

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

Engine -> (строка)

Указывает имя СУБД.

Status -> (строка)

Указывает состояние снимка кластера.

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

Указывает порт, на котором кластер прослушивал подключения во время создания снимка.

VpcId -> (строка)

Предоставляет идентификатор виртуальной частной сети (VPC), связанной со снимком кластера.

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

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

MasterUsername -> (строка)

Предоставляет имя пользователя-администратора для снимка кластера.

EngineVersion -> (строка)

Предоставляет версию СУБД для данного снимка кластера.

SnapshotType -> (строка)

Предоставляет тип снимка кластера.

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

Указывает процент завершенного переноса данных.

StorageEncrypted -> (булево)

Указывает, зашифрован ли снимок кластера.

KmsKeyId -> (строка)

Если StorageEncrypted является true, идентификатор ключа KMS для зашифрованного снимка кластера.

DBClusterSnapshotArn -> (строка)

Amazon Resource Name (ARN) снимка кластера.

SourceDBClusterSnapshotArn -> (строка)

Если снимок кластера был скопирован из исходного снимка кластера, ARN исходного снимка кластера; в противном случае значение NULL.

StorageType -> (строка)

Тип хранилища, связанный с вашим снимком кластера

Дополнительную информацию о типах хранилища для кластеров Amazon DocumentDB см. в разделе «Настройки хранилища кластера» в руководстве разработчика Amazon DocumentDB.

Допустимые значения для типа хранилища - standard | iopt1

Значение по умолчанию - standard