Spec-Zone.ru › AWS CLI v2

[ aws . redshift ]

modify-cluster-snapshot

Описание

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

В этом примере изменяется параметр срока хранения ручных моментальных снимков кластера.

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

Синтаксис

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

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

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

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

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

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

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

Логический параметр для переопределения исключения, если срок хранения уже истек.

--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
  • table
  • yaml
  • yaml-stream

--query (строка)

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

--profile (строка)

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

--region (строка)

Регион для использования. Переопределяет настройки из конфигурации/среды.

--version (строка)

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

--color (строка)

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

  • on
  • off
  • auto

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

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

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

Следующий пример устанавливает срок хранения ручных моментальных снимков для указанного моментального снимка кластера на 10 дней.

aws redshift modify-cluster-snapshot \
    --snapshot-identifier mycluster-2019-11-06-16-32 \
    --manual-snapshot-retention-period 10

Вывод:

{
    "Snapshot": {
        "SnapshotIdentifier": "mycluster-2019-11-06-16-32",
        "ClusterIdentifier": "mycluster",
        "SnapshotCreateTime": "2019-12-07T00:34:05.633Z",
        "Status": "available",
        "Port": 5439,
        "AvailabilityZone": "us-west-2f",
        "ClusterCreateTime": "2019-12-05T18:44:36.991Z",
        "MasterUsername": "adminuser",
        "ClusterVersion": "1.0",
        "SnapshotType": "manual",
        "NodeType": "dc2.large",
        "NumberOfNodes": 2,
        "DBName": "dev",
        "VpcId": "vpc-b1cel7t9",
        "Encrypted": false,
        "EncryptedWithHSM": false,
        "OwnerAccount": "123456789012",
        "TotalBackupSizeInMegaBytes": 64384.0,
        "ActualIncrementalBackupSizeInMegaBytes": 24.0,
        "BackupProgressInMegaBytes": 24.0,
        "CurrentBackupRateInMegaBytesPerSecond": 13.0011,
        "EstimatedSecondsToCompletion": 0,
        "ElapsedTimeInSeconds": 1,
        "Tags": [
            {
                "Key": "mytagkey",
                "Value": "mytagvalue"
            }
        ],
        "EnhancedVpcRouting": false,
        "MaintenanceTrackName": "current",
        "ManualSnapshotRetentionPeriod": 10,
        "ManualSnapshotRemainingDays": 6,
        "SnapshotRetentionStartTime": "2019-12-07T00:34:07.479Z"
    }
}

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

Вывод

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

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

SnapshotIdentifier -> (строка)

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

ClusterIdentifier -> (строка)

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

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

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

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

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

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

Порт -> (целое число)

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

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