get-backup-plan-from-template
Описание
Возвращает шаблон, указанный его templateId, как план резервного копирования.
См. также: Документацию API AWS
Синтаксис
get-backup-plan-from-template
--backup-plan-template-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-template-id (строка)
--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.
Примеры
Примечание
Для использования следующих примеров необходимо установить и настроить AWS CLI. Более подробная информация доступна в руководстве по началу работы в Руководстве пользователя AWS CLI.
Если не указано иное, все примеры используют правила цитирования, похожие на Unix. Эти примеры необходимо адаптировать к правилам цитирования вашей оболочки. Более подробная информация доступна в разделе Использование кавычек со строками в Руководстве пользователя AWS CLI.
Получение существующего плана резервного копирования из шаблона
Следующий get-backup-plan-from-template пример получает существующий план резервного копирования из шаблона, который определяет ежедневное резервное копирование с удержанием на 35 дней.
aws backup get-backup-plan-from-template \
--backup-plan-template-id "87c0c1ef-254d-4180-8fef-2e76a2c38aaa"
Вывод:
{
"BackupPlanDocument": {
"Rules": [
{
"RuleName": "DailyBackups",
"ScheduleExpression": "cron(0 5 ? * * *)",
"StartWindowMinutes": 480,
"Lifecycle": {
"DeleteAfterDays": 35
}
}
]
}
}
Дополнительную информацию можно найти в разделе Создание плана резервного копирования в Руководстве разработчика AWS Backup.
Вывод
BackupPlanDocument -> (структура)
Возвращает тело плана резервного копирования на основе целевой шаблона, включая имя, правила и хранилище резервных копий плана.
BackupPlanName -> (строка)
Отображаемое имя плана резервного копирования. Должно содержать только символы алфавитно-цифрового типа или специальные символы ‘-_.’.
Если это задано в консоли, оно может содержать от 1 до 50 символов; если это задано через командную строку или API, оно может содержать от 1 до 200 символов.
Rules -> (список)
Массив объектов BackupRule, каждый из которых определяет запланированную задачу, используемую для резервного копирования выбранного набора ресурсов.
(структура)
Определяет запланированную задачу, используемую для резервного копирования выбранного набора ресурсов.
RuleName -> (строка)
TargetBackupVaultName -> (строка)
ScheduleExpression -> (строка)
15 * ? * * * (создавать резервную копию каждый час в 15 минут после часа) и 0 12 * * ? * (создавать резервную копию каждый день в 12 часов по UTC). Для таблицы примеров нажмите на ссылку выше и прокрутите страницу вниз.StartWindowMinutes -> (целое)
Значение в минутах после того, как резервное копирование запланировано, прежде чем задача будет отменена, если она не начнется успешно. Это значение необязательно. Если это значение включено, оно должно быть не менее 60 минут, чтобы избежать ошибок.
В течение периода ожидания статус задачи резервного копирования сохраняется в статусе CREATED, пока она не начнется успешно или пока не истечет время ожидания. Если в течение периода ожидания Backup получает ошибку, позволяющую повторить попытку, Backup автоматически повторит попытку запуска задачи по меньшей мере каждые 10 минут, пока задача не начнется успешно (статус задачи изменится на RUNNING) или пока статус задачи не изменится на EXPIRED (что ожидается, когда истечет время ожидания).
CompletionWindowMinutes -> (целое)
Lifecycle -> (структура)
Жизненный цикл определяет, когда защищенный ресурс переходит в холодное хранилище и когда он истекает. Backup автоматически переводит и удаляет резервные копии в соответствии с определенным вами жизненным циклом.
Резервные копии, переведенные в холодное хранилище, должны храниться в холодном хранилище не менее 90 дней. Следовательно, параметр «сохранение» должен быть на 90 дней больше, чем параметр «переход в холодное хранилище после дней». Параметр «переход в холодное хранилище после дней» изменить нельзя после того, как резервная копия была переведена в холодное хранилище.
Типы ресурсов, которые могут переходить в холодное хранилище, перечислены в таблице Доступность функций по ресурсам. Backup игнорирует это выражение для других типов ресурсов.
MoveToColdStorageAfterDays -> (целое)
DeleteAfterDays -> (целое)
MoveToColdStorageAfterDays.OptInToArchiveForSupportedResources -> (булево)
RecoveryPointTags -> (карта)
Теги, назначенные ресурсам, связанным с этим правилом при восстановлении из резервной копии.
key -> (строка)
value -> (строка)
RuleId -> (строка)
CopyActions -> (список)
Массив объектов CopyAction, содержащий детали операции копирования.
(структура)
Детали операции копирования.
Lifecycle -> (структура)
Указывает период времени в днях, прежде чем точка восстановления переходит в холодное хранилище или удаляется.
Резервные копии, переведенные в холодное хранилище, должны храниться в холодном хранилище не менее 90 дней. Следовательно, в консоли параметр «сохранение» должен быть на 90 дней больше, чем параметр «переход в холодное хранилище после дней». Параметр «переход в холодное хранилище после дней» изменить нельзя после того, как резервная копия была переведена в холодное хранилище.
Типы ресурсов, которые могут переходить в холодное хранилище, перечислены в таблице Доступность функций по ресурсам. Backup игнорирует это выражение для других типов ресурсов.
Чтобы удалить существующие периоды жизненного цикла и сохранения и хранить точки восстановления неопределенно, укажите -1 для MoveToColdStorageAfterDays и DeleteAfterDays.
MoveToColdStorageAfterDays -> (целое)
DeleteAfterDays -> (целое)
MoveToColdStorageAfterDays.OptInToArchiveForSupportedResources -> (булево)
DestinationBackupVaultArn -> (строка)
arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.EnableContinuousBackup -> (булево)
ScheduleExpressionTimezone -> (строка)
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.