start-backup-job
Описание
Запускает задачу резервного копирования по требованию для указанного ресурса.
См. также: Документацию API AWS
Синтаксис
start-backup-job
--backup-vault-name <value>
--resource-arn <value>
--iam-role-arn <value>
[--idempotency-token <value>]
[--start-window-minutes <value>]
[--complete-window-minutes <value>]
[--lifecycle <value>]
[--recovery-point-tags <value>]
[--backup-options <value>]
[--index <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-vault-name (строка)
--resource-arn (строка)
--iam-role-arn (строка)
arn:aws:iam::123456789012:role/S3Access .--idempotency-token (строка)
StartBackupJob. Повторный запуск успешного запроса с тем же токеном идемпотентности приводит к сообщению об успехе без выполнения каких-либо действий.--start-window-minutes (целое число)
Значение в минутах после планирования резервного копирования, когда задача будет отменена, если она не успешно запустится. Это значение необязательно, и по умолчанию оно составляет 8 часов. Если это значение включено, оно должно быть не менее 60 минут, чтобы избежать ошибок.
Максимальное значение этого параметра составляет 100 лет (52 560 000 минут).
В течение временного интервала запуска статус задачи резервного копирования остается в состоянии CREATED, пока она не успешно начнётся или не истечёт время интервала запуска. Если в течение интервала запуска резервного копирования Backup получает ошибку, позволяющую повторно выполнить задачу, Backup будет автоматически пытаться запустить задачу как минимум каждые 10 минут, пока резервное копирование не начнётся успешно (статус задачи изменится на RUNNING) или пока статус задачи не изменится на EXPIRED (что ожидается, когда истечёт время интервала запуска).
--complete-window-minutes (целое число)
Значение в минутах, в течение которого успешно запущенное резервное копирование должно завершиться, иначе Backup отменит задачу. Это значение необязательно. Это значение начинает отсчёт с момента планирования резервного копирования. Оно не добавляет дополнительное время для StartWindowMinutes или если резервное копирование началось позже, чем было запланировано.
Как и в случае с StartWindowMinutes, максимальное значение этого параметра составляет 100 лет (52 560 000 минут).
--lifecycle (структура)
Жизненный цикл определяет, когда защищённый ресурс переходит в холодное хранилище и когда он истекает. Backup будет автоматически переводить и удалять резервные копии в соответствии с определённым вами жизненным циклом.
Резервные копии, переведённые в холодное хранилище, должны храниться в холодном хранилище не менее 90 дней. Поэтому значение «retention» должно быть на 90 дней больше значения «transition to cold after days». Значение «transition to cold after days» изменить нельзя после того, как резервная копия переведена в холодное хранилище.
Типы ресурсов, которые могут переходить в холодное хранилище, перечислены в таблице Доступность функций по ресурсам. Backup игнорирует это выражение для других типов ресурсов.
Максимальное значение этого параметра составляет 100 лет (36 500 дней).
MoveToColdStorageAfterDays -> (целое число)
DeleteAfterDays -> (целое число)
MoveToColdStorageAfterDays.OptInToArchiveForSupportedResources -> (булево)
Сокращённый синтаксис:
MoveToColdStorageAfterDays=long,DeleteAfterDays=long,OptInToArchiveForSupportedResources=boolean
Синтаксис JSON:
{
"MoveToColdStorageAfterDays": long,
"DeleteAfterDays": long,
"OptInToArchiveForSupportedResources": true|false
}
--recovery-point-tags (массив)
Теги, которые необходимо назначить ресурсам.
key -> (строка)
value -> (строка)
Сокращённый синтаксис:
KeyName1=string,KeyName2=string
Синтаксис JSON:
{"string": "string"
...}
--backup-options (массив)
Параметр резервного копирования для выбранного ресурса. Этот параметр доступен только для задач резервного копирования Windows Volume Shadow Copy Service (VSS).
Допустимые значения: Установите значение в "WindowsVSS":"enabled", чтобы включить параметр резервного копирования WindowsVSS и создать резервную копию Windows VSS. Установите значение в "WindowsVSS""disabled", чтобы создать обычную резервную копию. Параметр WindowsVSS по умолчанию не включён.
key -> (строка)
value -> (строка)
Сокращённый синтаксис:
KeyName1=string,KeyName2=string
Синтаксис JSON:
{"string": "string"
...}
--index (строка)
Включите этот параметр для включения создания индексов, если ваша задача резервного копирования имеет тип ресурса, поддерживающий индексы резервного копирования.
Типы ресурсов, поддерживающие индексы резервного копирования, включают:
-
EBSдля Amazon Elastic Block Store -
S3для Amazon Simple Storage Service (Amazon S3)
Индекс может иметь одно из двух возможных значений: ENABLED или DISABLED.
Чтобы создать индекс резервного копирования для подходящего ACTIVE момента восстановления, который ещё не имеет индекса резервного копирования, установите значение в ENABLED.
Чтобы удалить индекс резервного копирования, установите значение в DISABLED.
Возможные значения:
ENABLEDDISABLED
--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
- таблица
- yaml
- yaml-поток
--query (строка)
Запрос JMESPath для фильтрации данных ответа.
--profile (строка)
Использовать определённый профиль из файла идентификационных данных.
--region (строка)
Регион для использования. Переопределяет настройки конфигурации/среды.
--version (строка)
Отобразить версию этого инструмента.
--color (строка)
Включить/отключить цветной вывод.
- вкл
- выкл
- авто
--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.
Вывод
BackupJobId -> (строка)
RecoveryPointArn -> (строка)
ARN, уникально определяющий момент восстановления; например, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45 .
CreationDate -> (метка времени)
CreationDate точно до миллисекунд. Например, значение 1516925490.087 представляет пятницу, 26 января 2018 г., 00:11:30.087.IsParent -> (булево)
© Copyright 2025, Amazon Web Services. Created using Sphinx.
|
|