Spec-Zone.ru › AWS CLI v2

[ aws . backup ]

create-backup-plan

Описание

Создает план резервного копирования с использованием имени плана резервного копирования и правил резервного копирования. План резервного копирования — это документ, содержащий информацию, которую служба резервного копирования использует для планирования задач, которые создают точки восстановления для ресурсов.

Если вы вызываете CreateBackupPlan с планом, который уже существует, вы получите исключение AlreadyExistsException.

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

Синтаксис

  create-backup-plan
--backup-plan <value>
[--backup-plan-tags <value>]
[--creator-request-id <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 (структура)

Тело плана резервного копирования. Включает 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 (ARN), уникально определяющий целевое хранилище резервных копий для скопированной резервной копии. Например, arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.

EnableContinuousBackup -> (булево)

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

ScheduleExpressionTimezone -> (строка)

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

IndexActions -> (список)

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

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

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

(структура)

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

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

ResourceTypes -> (список)

Для каждого BackupRule будет принят 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 instances с 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"
        ...}
    }
    ...
  ]
}

--backup-plan-tags (карта)

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

key -> (строка)

value -> (строка)

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

KeyName1=string,KeyName2=string

Синтаксис JSON:

{"string": "string"
  ...}

--creator-request-id (строка)

Идентифицирует запрос и позволяет повторно выполнить проваленные запросы, не рискуя выполнить операцию дважды. Если запрос содержит CreatorRequestId, соответствующий существующему плану резервного копирования, возвращается этот план. Этот параметр необязателен.

Если используется, этот параметр должен содержать от 1 до 50 буквенно-цифровых символов или символов «-_.».

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

Файл сертификатов CA для проверки 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 версии 1, и двоичные значения должны быть переданы буквально. При предоставлении содержимого из файла, которое соответствует двоичному блоку, 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.

Примеры

Примечание

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

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

Для создания плана резервного копирования

Следующий create-backup-plan пример создает указанный план резервного копирования с сохранением на 35 дней.

aws backup create-backup-plan \
--backup-plan "{\"BackupPlanName\":\"Example-Backup-Plan\",\"Rules\":[{\"RuleName\":\"DailyBackups\",\"ScheduleExpression\":\"cron(0 5 ? * * *)\",\"StartWindowMinutes\":480,\"TargetBackupVaultName\":\"Default\",\"Lifecycle\":{\"DeleteAfterDays\":35}}]}"

Вывод:

{
    "BackupPlanId": "1fa3895c-a7f5-484a-a371-2dd6a1a9f729",
    "BackupPlanArn": "arn:aws:backup:us-west-2:123456789012:backup-plan:1fa3895c-a7f5-484a-a371-2dd6a1a9f729",
    "CreationDate": 1568928754.747,
    "VersionId": "ZjQ2ZTI5YWQtZDg5Yi00MzYzLWJmZTAtMDI1MzhlMDhjYjEz"
}

Дополнительную информацию см. в разделе Создание плана резервного копирования в Руководстве разработчика AWS Backup.

Вывод

BackupPlanId -> (строка)

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

BackupPlanArn -> (строка)

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

CreationDate -> (временная метка)

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

VersionId -> (строка)

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

AdvancedBackupSettings -> (список)

Параметры для типа ресурса. Этот параметр доступен только для задач резервного копирования 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 -> (строка)

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

Spec-Zone.ru

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