Spec-Zone.ru › AWS CLI v2

[ aws . redshift ]

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

Описание

Создаёт ручной снимок указанного кластера. Кластер должен находиться в состоянии available.

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

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

Синтаксис

  create-cluster-snapshot
--snapshot-identifier <value>
--cluster-identifier <value>
[--manual-snapshot-retention-period <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]

Параметры

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

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

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

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

Пример: my-snapshot-id

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

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

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

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

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

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

--tags (список)

Список экземпляров тегов.

(структура)

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

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

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

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

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

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

Key=string,Value=string ...

Синтаксис JSON:

[
  {
    "Key": "string",
    "Value": "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
  • text
  • таблица
  • 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-auto-prompt (логическое значение)

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

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

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

Примеры

Примечание

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

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

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

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

Команда:

aws redshift create-cluster-snapshot --cluster-identifier mycluster --snapshot-identifier my-snapshot-id

Результат:

{
   "Snapshot": {
      "Status": "creating",
      "SnapshotCreateTime": "2013-01-22T22:20:33.548Z",
      "AvailabilityZone": "us-east-1a",
      "ClusterVersion": "1.0",
      "MasterUsername": "adminuser",
      "DBName": "dev",
      "ClusterCreateTime": "2013-01-22T21:59:29.559Z",
      "SnapshotType": "manual",
      "NodeType": "dw.hs1.xlarge",
      "ClusterIdentifier": "mycluster",
      "Port": 5439,
      "NumberOfNodes": "2",
      "SnapshotIdentifier": "my-snapshot-id"
   },
   "ResponseMetadata": {
      "RequestId": "f024d1a5-64e1-11e2-88c5-53eb05787dfb"
   }
}

Вывод

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

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

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 -> (строка)

Идентификатор ключа Key Management Service (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 в разделе Расширенное маршрутизация VPC.

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

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

MaintenanceTrackName -> (строка)

Имя потока обслуживания для снимка.

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

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

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

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

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

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

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

MasterPasswordSecretArn -> (строка)

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

MasterPasswordSecretKmsKeyId -> (строка)

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

SnapshotArn -> (строка)

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

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

Spec-Zone.ru

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