Spec-Zone.ru › AWS CLI v2

[ aws . backup ]

update-backup-plan

Описание

Обновляет указанный план резервного копирования. Новая версия однозначно определяется ее ID.

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

Синтаксис

  update-backup-plan
--backup-plan-id <value>
--backup-plan <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]

Параметры

--backup-plan-id (строка)

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

--backup-plan (структура)

Тело плана резервного копирования. Включает BackupPlanName и один или несколько наборов Rules.

BackupPlanName -> (строка)

Имя отображения плана резервного копирования. Должно содержать от 1 до 50 символов алфавитно-цифрового формата или символы «-_.».

Rules -> (список)

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

(структура)

Определяет запланированную задачу для резервного копирования набора ресурсов.

RuleName -> (строка)

Имя отображения правила резервного копирования. Должно содержать от 1 до 50 символов алфавитно-цифрового формата или символы «-_.».

TargetBackupVaultName -> (строка)

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

ScheduleExpression -> (строка)

Выражение CRON в формате UTC, указывающее, когда Backup инициирует задачу резервного копирования.

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

Значение в минутах после планирования резервного копирования, до которого задача будет отменена, если не запустится успешно. Это значение необязательно. Если это значение включено, оно должно быть не менее 60 минут, чтобы избежать ошибок.

Максимальное значение этого параметра составляет 100 лет (52 560 000 минут).

В течение начального интервала статус задачи резервного копирования остается в статусе CREATED, пока она не начнётся успешно или не истечёт интервал. Если в течение начального интервала Backup получает ошибку, которая позволяет повторить задачу, Backup автоматически будет пытаться запустить задачу по крайней мере каждые 10 минут, пока задача не начнётся успешно (статус задачи изменится на RUNNING) или пока статус задачи не изменится на EXPIRED (что ожидается, когда истечёт начальный интервал).

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

Значение в минутах после успешного запуска задачи резервного копирования, до которого она должна быть завершена, иначе будет отменена Backup. Это значение необязательно.

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

Жизненный цикл определяет, когда защищённый ресурс переводится в холодное хранилище и когда он истекает. Backup будет автоматически переводить и удалять резервные копии в соответствии с определённым вами жизненным циклом.

Резервные копии, переведённые в холодное хранилище, должны храниться в холодном хранилище не менее 90 дней. Поэтому значение «retention» должно быть на 90 дней больше значения «transition to cold after days». Значение «transition to cold after days» изменить нельзя после того, как резервная копия была переведена в холодное хранилище.

Типы ресурсов, которые могут быть переведены в холодное хранилище, перечислены в таблице Доступность функций по ресурсам. Backup игнорирует это выражение для других типов ресурсов.

Максимальное значение этого параметра составляет 100 лет (36 500 дней).

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

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

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

Количество дней после создания, когда точка восстановления удаляется. Это значение должно быть не менее 90 дней после значения, указанного в MoveToColdStorageAfterDays.

OptInToArchiveForSupportedResources -> (булево)

Если значение true, ваш план резервного копирования переводит поддерживаемые ресурсы в уровень холодного хранилища (архива) в соответствии с настройками жизненного цикла.

RecoveryPointTags -> (карта)

Теги, которые необходимо назначить ресурсам.

key -> (строка)

value -> (строка)

CopyActions -> (список)

Массив объектов CopyAction, содержащих подробности операции копирования.

(структура)

Подробности операции копирования.

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

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

Резервные копии, переведённые в холодное хранилище, должны храниться в холодном хранилище не менее 90 дней. Поэтому на консоли значение «retention» должно быть на 90 дней больше значения «transition to cold after days». Значение «transition to cold after days» изменить нельзя после того, как резервная копия была переведена в холодное хранилище.

Типы ресурсов, которые могут быть переведены в холодное хранилище, перечислены в таблице Доступность функций по ресурсам. Backup игнорирует это выражение для других типов ресурсов.

Чтобы удалить существующие периоды жизненного цикла и хранения и сохранить точки восстановления неопределённо, укажите -1 для MoveToColdStorageAfterDays и DeleteAfterDays.

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

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

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

Количество дней после создания, когда точка восстановления удаляется. Это значение должно быть не менее 90 дней после значения, указанного в MoveToColdStorageAfterDays.

OptInToArchiveForSupportedResources -> (булево)

Если значение true, ваш план резервного копирования переводит поддерживаемые ресурсы в уровень холодного хранилища (архива) в соответствии с настройками жизненного цикла.

DestinationBackupVaultArn -> (строка)

Amazon Resource Name (ARN), который однозначно идентифицирует целевое хранилище резервных копий для скопированной резервной копии. Например, arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.

EnableContinuousBackup -> (булево)

Указывает, создаёт ли Backup непрерывные резервные копии. True приводит к созданию Backup непрерывных резервных копий, позволяющих восстанавливать данные в любой момент времени (PITR). False (или не указано) приводит к созданию резервных копий в виде снимков.

ScheduleExpressionTimezone -> (строка)

Часовой пояс, в котором задано выражение расписания. По умолчанию выражения расписания задаются в UTC. Можно изменить на указанный часовой пояс.

IndexActions -> (список)

В каждом правиле резервного копирования может быть не более одного действия индексирования, так как каждое резервное копирование может иметь 0 или 1 индекс, связанный с ним.

В массиве находится ResourceTypes. Для каждого правила резервного копирования будет принят только 1 тип ресурса. Допустимые значения:

  • EBS для Amazon Elastic Block Store
  • S3 для Amazon Simple Storage Service (Amazon S3)

(структура)

Это необязательный массив внутри правила резервного копирования.

IndexAction состоит из одного ResourceTypes.

ResourceTypes -> (список)

Для каждого правила резервного копирования будет принят 0 или 1 действие индексирования.

Допустимые значения:

  • EBS для Amazon Elastic Block Store
  • S3 для Amazon Simple Storage Service (Amazon S3)

(строка)

AdvancedBackupSettings -> (список)

Указывает список BackupOptions для каждого типа ресурса. Эти параметры доступны только для задач резервного копирования Windows Volume Shadow Copy Service (VSS).

(структура)

Параметры резервного копирования для каждого типа ресурса.

ResourceType -> (строка)

Указывает объект, содержащий тип ресурса и параметры резервного копирования. Поддерживается только тип ресурса — экземпляры Amazon EC2 с Windows Volume Shadow Copy Service (VSS). Пример CloudFormation см. в образце шаблона CloudFormation для включения Windows VSS в руководстве пользователя Backup.

Допустимые значения: EC2.

BackupOptions -> (карта)

Указывает параметр резервного копирования для выбранного ресурса. Этот параметр доступен только для задач резервного копирования Windows VSS.

Допустимые значения:

Установите "WindowsVSS":"enabled", чтобы включить параметр резервного копирования WindowsVSS и создать резервную копию Windows VSS.

Установите "WindowsVSS":"disabled", чтобы создать обычную резервную копию. Параметр WindowsVSS не включен по умолчанию.

Если вы укажете недопустимый параметр, получите исключение InvalidParameterValueException.

Дополнительная информация о резервных копиях Windows VSS: Создание резервной копии Windows с поддержкой VSS.

key -> (строка)

value -> (строка)

Синтаксис JSON:

{
  "BackupPlanName": "string",
  "Rules": [
    {
      "RuleName": "string",
      "TargetBackupVaultName": "string",
      "ScheduleExpression": "string",
      "StartWindowMinutes": long,
      "CompletionWindowMinutes": long,
      "Lifecycle": {
        "MoveToColdStorageAfterDays": long,
        "DeleteAfterDays": long,
        "OptInToArchiveForSupportedResources": true|false
      },
      "RecoveryPointTags": {"string": "string"
        ...},
      "CopyActions": [
        {
          "Lifecycle": {
            "MoveToColdStorageAfterDays": long,
            "DeleteAfterDays": long,
            "OptInToArchiveForSupportedResources": true|false
          },
          "DestinationBackupVaultArn": "string"
        }
        ...
      ],
      "EnableContinuousBackup": true|false,
      "ScheduleExpressionTimezone": "string",
      "IndexActions": [
        {
          "ResourceTypes": ["string", ...]
        }
        ...
      ]
    }
    ...
  ],
  "AdvancedBackupSettings": [
    {
      "ResourceType": "string",
      "BackupOptions": {"string": "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 (boolean)

Включить отладку.

--endpoint-url (string)

Переопределить URL команды заданным URL.

--no-verify-ssl (boolean)

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

--no-paginate (boolean)

Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один вызов для первой страницы результатов.

--output (string)

Стиль форматирования вывода команды.

  • json
  • text
  • table
  • yaml
  • yaml-stream

--query (string)

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

--profile (string)

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

--region (string)

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

--version (string)

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

--color (string)

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

  • on
  • off
  • auto

--no-sign-request (boolean)

Не подписывать запросы. Кредиты не будут загружены, если этот аргумент указан.

--ca-bundle (string)

Файл с корневым сертификатом для проверки SSL-сертификатов. Переопределяет настройки конфигурации/среды.

--cli-read-timeout (int)

Максимальное время чтения сокета в секундах. Если значение равно 0, чтение сокета будет выполняться блокирующим образом без таймаута. Значение по умолчанию — 60 секунд.

--cli-connect-timeout (int)

Максимальное время подключения к сокету в секундах. Если значение равно 0, подключение к сокету будет выполняться блокирующим образом без таймаута. Значение по умолчанию — 60 секунд.

--cli-binary-format (string)

Стиль форматирования для двоичных блоков. Формат по умолчанию — 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 (boolean)

Отключить вывод пайпера CLI.

--cli-auto-prompt (boolean)

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

--no-cli-auto-prompt (boolean)

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

Вывод

BackupPlanId -> (string)

Уникально идентифицирует план резервного копирования.

BackupPlanArn -> (string)

Идентификатор Amazon Resource Name (ARN), уникально идентифицирующий план резервного копирования; например, arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50 .

CreationDate -> (timestamp)

Дата и время создания плана резервного копирования в формате Unix и по координированному всемирному времени (UTC). Значение CreationDate точно до миллисекунд. Например, значение 1516925490.087 соответствует пятнице, 26 января 2018 года, 00:11:30.087.

VersionId -> (string)

Уникальные, случайным образом сгенерированные, строки Unicode, UTF-8, длиной не более 1024 байт. Идентификаторы версии не могут быть изменены.

AdvancedBackupSettings -> (list)

Содержит список BackupOptions для каждого типа ресурса.

(structure)

Параметры резервного копирования для каждого типа ресурса.

ResourceType -> (string)

Указывает объект, содержащий тип ресурса и параметры резервного копирования. Единственный поддерживаемый тип ресурса — экземпляры Amazon EC2 с Windows Volume Shadow Copy Service (VSS). Пример с CloudFormation см. в образце шаблона CloudFormation для включения Windows VSS в Руководстве по резервному копированию.

Допустимые значения: EC2 .

BackupOptions -> (map)

Указывает параметр резервного копирования для выбранного ресурса. Этот параметр доступен только для задач резервного копирования Windows VSS.

Допустимые значения:

Установите значение "WindowsVSS":"enabled" для включения параметра резервного копирования WindowsVSS и создания резервной копии Windows VSS.

Установите значение "WindowsVSS":"disabled" для создания обычной резервной копии. Параметр WindowsVSS не включён по умолчанию.

Если вы укажете недопустимый параметр, будет получено исключение InvalidParameterValueException.

Дополнительную информацию о резервных копиях Windows VSS см. в статье Создание резервной копии Windows с поддержкой VSS.

key -> (string)

value -> (string)

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

Spec-Zone.ru

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