Spec-Zone.ru › AWS CLI v2

[ aws . redshift ]

authorize-snapshot-access

Описание

Авторизует указанную учётную запись Amazon Web Services для восстановления указанного моментального снимка.

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

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

Синтаксис

  authorize-snapshot-access
[--snapshot-identifier <value>]
[--snapshot-arn <value>]
[--snapshot-cluster-identifier <value>]
--account-with-restore-access <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 (строка)

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

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

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

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

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

  • Если моментальный снимок для доступа не существует, а связанное разрешение IAM не позволяет доступ ко всем () моментальным снимкам* - Этот параметр необходим. В противном случае разрешения недоступны для проверки существования моментального снимка.
  • Если моментальный снимок для доступа существует - Этот параметр не требуется. Redshift может получить идентификатор кластера и использовать его для проверки авторизации доступа к моментальному снимку.

--account-with-restore-access (строка)

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

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

--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 для вывода.

--cli-auto-prompt (булево)

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

--no-cli-auto-prompt (булево)

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

Примеры

Примечание

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

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

Авторизация учётной записи AWS для восстановления моментального снимка

В этом примере авторизуется учётная запись AWS 444455556666 для восстановления моментального снимка my-snapshot-id. По умолчанию вывод в формате JSON.

Команда:

aws redshift authorize-snapshot-access --snapshot-id my-snapshot-id --account-with-restore-access 444455556666

Результат:

{
   "Snapshot": {
      "Status": "available",
      "SnapshotCreateTime": "2013-07-17T22:04:18.947Z",
      "EstimatedSecondsToCompletion": 0,
      "AvailabilityZone": "us-east-1a",
      "ClusterVersion": "1.0",
      "MasterUsername": "adminuser",
      "Encrypted": false,
      "OwnerAccount": "111122223333",
      "BackupProgressInMegabytes": 11.0,
      "ElapsedTimeInSeconds": 0,
      "DBName": "dev",
      "CurrentBackupRateInMegabytesPerSecond: 0.1534,
      "ClusterCreateTime": "2013-01-22T21:59:29.559Z",
      "ActualIncrementalBackupSizeInMegabytes"; 11.0,
      "SnapshotType": "manual",
      "NodeType": "dw.hs1.xlarge",
      "ClusterIdentifier": "mycluster",
      "TotalBackupSizeInMegabytes": 20.0,
      "Port": 5439,
      "NumberOfNodes": 2,
      "SnapshotIdentifier": "my-snapshot-id"
   }
}

Вывод

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

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

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. Более подробную информацию см. в разделе Расширенная маршрутизация 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