Spec-Zone.ru › AWS CLI v2

[ aws . redshift ]

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

Описание

Копирует указанный автоматический снимок кластера в новый ручной снимок кластера. Источник должен быть автоматическим снимком и находиться в состоянии доступности.

При удалении кластера Amazon Redshift удаляет любые автоматические снимки этого кластера. Также, по истечении срока хранения снимка, Amazon Redshift автоматически удаляет его. Если вы хотите сохранить автоматический снимок на более длительный срок, можно создать ручную копию снимка. Ручные снимки сохраняются до их удаления.

Дополнительную информацию о работе со снимками можно найти в разделе Amazon Redshift Snapshots в руководстве Amazon Redshift Cluster Management Guide.

См. также: AWS API Documentation

Синтаксис

  copy-cluster-snapshot
--source-snapshot-identifier <value>
[--source-snapshot-cluster-identifier <value>]
--target-snapshot-identifier <value>
[--manual-snapshot-retention-period <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-snapshot-identifier (строка)

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

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

  • Должен быть идентификатором допустимого автоматического снимка, состояние которого available .

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

Идентификатор кластера, из которого был создан исходный снимок. Этот параметр требуется, если у вашего пользователя IAM есть политика, содержащая элемент ресурса snapshot, который указывает что-либо кроме * для имени кластера.

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

  • Должен быть идентификатором допустимого кластера.

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

Идентификатор, присвоенный новому ручному снимку.

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

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

--manual-snapshot-retention-period (целое число)

Количество дней, в течение которых сохраняется ручной снимок. Если значение равно -1, ручной снимок хранится неопределенно долго.

Значение должно быть либо -1, либо целым числом от 1 до 3653.

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

--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 в руководстве AWS CLI User Guide.

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

Получение описания всех версий кластера

Этот пример возвращает описание всех версий кластера. По умолчанию вывод находится в формате JSON.

Команда:

aws redshift copy-cluster-snapshot --source-snapshot-identifier cm:examplecluster-2013-01-22-19-27-58 --target-snapshot-identifier my-saved-snapshot-copy

Результат:

{
   "Snapshot": {
      "Status": "available",
      "SnapshotCreateTime": "2013-01-22T19:27:58.931Z",
      "AvailabilityZone": "us-east-1c",
      "ClusterVersion": "1.0",
      "MasterUsername": "adminuser",
      "DBName": "dev",
      "ClusterCreateTime": "2013-01-22T19:23:59.368Z",
      "SnapshotType": "manual",
      "NodeType": "dw.hs1.xlarge",
      "ClusterIdentifier": "examplecluster",
      "Port": 5439,
      "NumberOfNodes": "2",
      "SnapshotIdentifier": "my-saved-snapshot-copy"
   },
   "ResponseMetadata": {
      "RequestId": "3b279691-64e3-11e2-bec0-17624ad140dd"
   }
}

Вывод

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

Описание снимка.

SnapshotIdentifier -> (строка)

Идентификатор снимка, предоставленный в запросе.

ClusterIdentifier -> (строка)

Идентификатор кластера, для которого был сделан снимок.

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

Время (в формате UTC), когда Amazon Redshift начал создание снимка. Снимок содержит копию данных кластера на этот точный момент времени.

Status -> (строка)

Статус снимка. Значение статуса зависит от используемой операции API:

  • CreateClusterSnapshot и CopyClusterSnapshot возвращают статус как “создание”.
  • DescribeClusterSnapshots возвращает статус как “создание”, “доступен”, “окончательный снимок” или “неудачно”.
  • DeleteClusterSnapshot возвращает статус как “удален”.

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

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

AvailabilityZone -> (строка)

Зона доступности, в которой был создан кластер.

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

Время (UTC), когда кластер был первоначально создан.

MasterUsername -> (строка)

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

ClusterVersion -> (строка)

Идентификатор версии движка Amazon Redshift, работающего в кластере.

EngineFullVersion -> (строка)

Версия кластера, используемая для создания снимка. Например, 1.0.15503.

SnapshotType -> (строка)

Тип снимка. Снимки, созданные с помощью CreateClusterSnapshot и CopyClusterSnapshot, имеют тип “ручной”.

NodeType -> (строка)

Тип узла узлов в кластере.

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

Количество узлов в кластере.

DBName -> (строка)

Имя базы данных, созданной при создании кластера.

VpcId -> (строка)

Идентификатор VPC кластера, если снимок получен из кластера в VPC. В противном случае это поле отсутствует в выводе.

Encrypted -> (логическое значение)

Если true, данные в снимке зашифрованы в состоянии покоя.

KmsKeyId -> (строка)

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

EncryptedWithHSM -> (логическое значение)

Логическое значение, которое указывает, зашифрованы ли данные снимка с использованием ключей HSM исходного кластера. true указывает, что данные зашифрованы с использованием ключей HSM.

AccountsWithRestoreAccess -> (список)

Список учетных записей Amazon Web Services, имеющих разрешение на восстановление снимка. Возвращает null, если учетные записи не авторизованы. Виден только владельцу снимка.

(структура)

Описание учетной записи Amazon Web Services, авторизованной для восстановления снимка.

AccountId -> (строка)

Идентификатор учетной записи Amazon Web Services, авторизованной для восстановления снимка.

AccountAlias -> (строка)

Идентификатор учетной записи поддержки Amazon Web Services, авторизованной для восстановления снимка. Для поддержки Amazon Web Services идентификатор — amazon-redshift-support.

OwnerAccount -> (строка)

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

TotalBackupSizeInMegaBytes -> (двойное)

Размер полного набора данных резервного копирования, которые будут использованы для восстановления кластера.

ActualIncrementalBackupSizeInMegaBytes -> (двойное)

Размер инкрементного резервного копирования.

BackupProgressInMegaBytes -> (двойное)

Количество мегабайтов, которые были переданы в резервное копирование снимка.

CurrentBackupRateInMegaBytesPerSecond -> (двойное)

Количество мегабайтов в секунду, передаваемых в резервное копирование снимка. Возвращает 0 для завершенного резервного копирования.

EstimatedSecondsToCompletion -> (целое число с большой точностью)

Ожидаемое время до завершения резервного копирования снимка. Возвращает 0 для завершенного резервного копирования.

ElapsedTimeInSeconds -> (целое число с большой точностью)

Время работы в процессе создания снимка или время завершения завершенного резервного копирования.

SourceRegion -> (строка)

Исходная область, из которой был скопирован снимок.

Tags -> (список)

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

(структура)

Тег, состоящий из пары имя/значение для ресурса.

Key -> (строка)

Ключ или имя тега ресурса.

Value -> (строка)

Значение тега ресурса.

RestorableNodeTypes -> (список)

Список типов узлов, в которые можно восстановить этот снимок кластера.

(строка)

EnhancedVpcRouting -> (логическое значение)

Параметр, который указывает, включена ли расширенная маршрутизация VPC. Чтобы создать кластер, использующий расширенную маршрутизацию VPC, кластер должен находиться в VPC. Дополнительная информация в руководстве по управлению кластерами Amazon Redshift.

Если этот параметр true, расширенная маршрутизация VPC включена.

По умолчанию: false

MaintenanceTrackName -> (строка)

Имя траектории технического обслуживания для снимка.

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

Количество дней, в течение которых сохраняется ручной снимок. Если значение равно -1, ручной снимок сохраняется неограниченно.

Значение должно быть либо -1, либо целым числом от 1 до 3653.

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

Количество дней до истечения срока хранения ручного снимка.

SnapshotRetentionStartTime -> (метка времени)

Метка времени, представляющая начало периода хранения снимка.

MasterPasswordSecretArn -> (строка)

Amazon Resource Name (ARN) для секрета учетных данных административного пользователя кластера.

MasterPasswordSecretKmsKeyId -> (строка)

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

SnapshotArn -> (строка)

Amazon Resource Name (ARN) снимка.

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

Spec-Zone.ru

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