Spec-Zone.ru › AWS CLI v2

[ aws . backup ]

get-backup-plan-from-json

Описание

Возвращает допустимый документ JSON, определяющий план резервного копирования, или ошибку.

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

Синтаксис

  get-backup-plan-from-json
--backup-plan-template-json <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-template-json (строка)

Документ плана резервного копирования, предоставленный клиентом, в формате JSON.

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

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

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

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

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

Вывод

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

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

BackupPlanName -> (строка)

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

Если это значение задано в консоли, оно может содержать от 1 до 50 символов; если это значение задано через командную строку или API, оно может содержать от 1 до 200 символов.

Rules -> (список)

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

(структура)

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

RuleName -> (строка)

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

TargetBackupVaultName -> (строка)

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

ScheduleExpression -> (строка)

Выражение cron в UTC, указывающее, когда Backup запускает задание резервного копирования. Дополнительную информацию об выражениях cron Amazon Web Services см. в разделе «Выражения планирования для правил» в Руководстве пользователя Amazon CloudWatch Events. Два примера выражений cron Amazon Web Services: 15 * ? * * * (создать резервную копию каждый час в 15 минут после часа) и 0 12 * * ? * (создать резервную копию каждый день в 12:00 по UTC). Таблица примеров доступна по ссылке выше.

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

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

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

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

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

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

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

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

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

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

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

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

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

OptInToArchiveForSupportedResources -> (булево)

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

RecoveryPointTags -> (карта)

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

key -> (строка)

value -> (строка)

RuleId -> (строка)

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

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 -> (список)

IndexActions — это массив, используемый для указания того, как должны индексироваться данные резервной копии.

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

В массиве находится ResourceType. Будет принят только один для каждого BackupRule.

(структура)

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

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

ResourceTypes -> (список)

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

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

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

(строка)

AdvancedBackupSettings -> (список)

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

(структура)

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

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.

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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