create-lifecycle-policy

Описание

Создаёт политику жизненного цикла Amazon Data Lifecycle Manager. Amazon Data Lifecycle Manager поддерживает следующие типы политик:

Настраиваемая политика моментальных снимков EBS
Настраиваемая политика AMI, основанная на EBS
Политика событий копирования между аккаунтами
Политика по умолчанию для моментальных снимков EBS
Политика по умолчанию для AMI, основанных на EBS

Дополнительная информация: Политики по умолчанию против настраиваемых политик.

Предупреждение

Если вы создаёте политику по умолчанию, вы можете указать параметры запроса либо в теле запроса, либо в структуре запроса PolicyDetails, но не оба.

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

Синтаксис

  create-lifecycle-policy
--execution-role-arn <value>
--description <value>
--state <value>
[--policy-details <value>]
[--tags <value>]
[--default-policy <value>]
[--create-interval <value>]
[--retain-interval <value>]
[--copy-tags | --no-copy-tags]
[--extend-deletion | --no-extend-deletion]
[--cross-region-copy-targets <value>]
[--exclusions <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]

Параметры

--execution-role-arn (строка)

Amazon Resource Name (ARN) роли IAM, используемой для выполнения операций, указанных в политике жизненного цикла.

--description (строка)

Описание политики жизненного цикла. Поддерживаются символы ^[0-9A-Za-z _-]+$.

--state (строка)

Состояние активации политики жизненного цикла после создания.

Возможные значения:

ENABLED
DISABLED

--policy-details (структура)

Подробные данные о конфигурации политики жизненного цикла.

Предупреждение

PolicyType -> (строка)

Тип политики. Укажите EBS_SNAPSHOT_MANAGEMENT для создания политики жизненного цикла, управляющей жизненным циклом моментальных снимков Amazon EBS. Укажите IMAGE_MANAGEMENT для создания политики жизненного цикла, управляющей жизненным циклом AMI, основанных на EBS. Укажите EVENT_BASED_POLICY для создания политики на основе событий, выполняющей определённые действия при возникновении определённого события в вашем аккаунте Amazon Web Services.

По умолчанию: EBS_SNAPSHOT_MANAGEMENT.

ResourceTypes -> (список)

[Только политики моментальных снимков] Тип целевого ресурса для политик жизненного цикла моментальных снимков и AMI. Используйте VOLUME для создания моментальных снимков отдельных томов или INSTANCE для создания моментальных снимков нескольких томов из томов экземпляра.

(строка)

ResourceLocations -> (список)

[Только настраиваемые политики моментальных снимков и AMI] Расположение ресурсов для резервного копирования.

Если исходные ресурсы находятся в Регионе, укажите CLOUD . В этом случае политика затрагивает все ресурсы указанного типа с соответствующими метками во всех зонах доступности в Регионе.
[Только настраиваемые политики моментальных снимков] Если исходные ресурсы находятся в локальной зоне, укажите LOCAL_ZONE . В этом случае политика затрагивает все ресурсы указанного типа с соответствующими метками во всех локальных зонах в Регионе.
Если исходные ресурсы находятся на Outpost в вашем аккаунте, укажите OUTPOST . В этом случае политика затрагивает все ресурсы указанного типа с соответствующими метками во всех Outpost в вашем аккаунте.

(строка)

TargetTags -> (список)

[Только настраиваемые политики моментальных снимков и AMI] Единственная метка, идентифицирующая целевые ресурсы для этой политики.

(структура)

Указывает метку для ресурса.

Key -> (строка)

Ключ метки.

Value -> (строка)

Значение метки.

Schedules -> (список)

[Только политики пользовательских снимков и AMI] Расписание действий, определенных политикой, для снимков и политики жизненного цикла AMI. Политика может содержать до четырех расписаний — одно обязательное и до трех необязательных.

(структура)

[Только политики пользовательских снимков и AMI] Указывает расписание для политики жизненного цикла снимка или AMI.

Name -> (строка)

Имя расписания.

CopyTags -> (булево)

Копировать все пользовательские теги на исходном томе в снимки тома, созданные этой политикой.

TagsToAdd -> (список)

Теги, которые нужно применить к ресурсам, созданным политикой. Эти пользовательские теги дополняют теги жизненного цикла, добавленные Amazon Web Services.

(структура)

Указывает тег для ресурса.

Key -> (строка)

Ключ тега.

Value -> (строка)

Значение тега.

VariableTags -> (список)

[Политики AMI и политики снимков, которые нацелены только на экземпляры] Коллекция пар ключ/значение со значениями, определяемыми динамически при выполнении политики. Ключи могут быть любым допустимым ключом тега Amazon EC2. Значения должны быть в одном из двух следующих форматов: $(instance-id) или $(timestamp). Переменные теги действительны только для управления снимками EBS – политики экземпляров.

(структура)

Указывает тег для ресурса.

Key -> (строка)

Ключ тега.

Value -> (строка)

Значение тега.

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

Правило создания.

Location -> (строка)

[Только политики пользовательских снимков] Указывает место назначения для снимков, созданных политикой. Разрешенные места назначения зависят от расположения целевых ресурсов.

Если политика нацелена на ресурсы в Регионе, необходимо создавать снимки в том же Регионе, что и исходный ресурс.
Если политика нацелена на ресурсы в локальной зоне, можно создавать снимки в той же локальной зоне или в родительском Регионе.
Если политика нацелена на ресурсы на Outpost, можно создавать снимки на том же Outpost или в его родительском Регионе.

Укажите одно из следующих значений:

Чтобы создать снимки в том же Регионе, что и исходный ресурс, укажите CLOUD.
Чтобы создать снимки в той же локальной зоне, что и исходный ресурс, укажите LOCAL_ZONE.
Чтобы создать снимки на том же Outpost, что и исходный ресурс, укажите OUTPOST_LOCAL.

По умолчанию: CLOUD

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

Интервал между снимками. Допустимые значения: 1, 2, 3, 4, 6, 8, 12 и 24.

IntervalUnit -> (строка)

Единица интервала.

Times -> (список)

Время начала операции в формате UTC. Поддерживается формат чч:мм.

Операция выполняется в течение одного часа после указанного времени. Если время не указано, Amazon Data Lifecycle Manager выбирает время в течение следующих 24 часов.

(строка)

CronExpression -> (строка)

Расписание в формате Cron. Интервал расписания должен составлять от 1 часа до 1 года. Дополнительные сведения см. в справке по выражениям Cron в руководстве пользователя Amazon EventBridge.

Scripts -> (список)

[Политики пользовательских снимков, которые нацелены только на экземпляры] Указывает скрипты до и/или после для политики жизненного цикла снимка, которая нацелена только на экземпляры. Это полезно для создания снимков с приложением, согласованным по состоянию, или для выполнения определенных административных задач до или после того, как Amazon Data Lifecycle Manager инициирует создание снимка.

Дополнительную информацию см. в разделе Автоматизация снимков с приложением, согласованными по состоянию, с помощью скриптов до и после.

(структура)

[Политики пользовательских снимков, которые нацелены только на экземпляры] Информация о скриптах до и/или после для политики жизненного цикла снимка, которая нацелена на экземпляры. Дополнительную информацию см. в разделе Автоматизация снимков с приложением, согласованными по состоянию, с помощью скриптов до и после.

Stages -> (список)

Указывают, какие скрипты Amazon Data Lifecycle Manager должен запустить на целевых экземплярах. Скрипты до запускаются до того, как Amazon Data Lifecycle Manager инициирует создание снимка. Скрипты после запускаются после того, как Amazon Data Lifecycle Manager инициирует создание снимка.

Чтобы запустить только скрипт до, укажите PRE. В этом случае Amazon Data Lifecycle Manager вызывает документ SSM с параметром pre-script перед началом создания снимка.
Чтобы запустить только скрипт после, укажите POST. В этом случае Amazon Data Lifecycle Manager вызывает документ SSM с параметром post-script после начала создания снимка.
Чтобы запустить скрипты до и после, укажите оба PRE и POST. В этом случае Amazon Data Lifecycle Manager вызывает документ SSM с параметром pre-script перед началом создания снимка, а затем снова вызывает документ SSM с параметром post-script после начала создания снимка.

Если вы автоматизируете резервные копии VSS, опустите этот параметр.

По умолчанию: PRE и POST

(строка)

ExecutionHandlerService -> (строка)

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

Если вы используете пользовательские документы SSM или автоматизируете снимки с приложением, согласованным по состоянию, для рабочих нагрузок SAP HANA, укажите AWS_SYSTEMS_MANAGER.
Если вы автоматизируете резервные копии VSS, опустите этот параметр.

По умолчанию: AWS_SYSTEMS_MANAGER

ExecutionHandler -> (строка)

Документ SSM, содержащий скрипты до и/или после для выполнения.

Если вы автоматизируете резервные копии VSS, укажите AWS_VSS_BACKUP. В этом случае Amazon Data Lifecycle Manager автоматически использует документ SSM AWSEC2-CreateVssSnapshot.
Если вы автоматизируете снимки с приложением, согласованным по состоянию, для рабочих нагрузок SAP HANA, укажите AWSSystemsManagerSAP-CreateDLMSnapshotForSAPHANA.
Если вы используете пользовательский документ SSM, который вам принадлежит, укажите имя или ARN документа SSM. Если вы используете пользовательский документ SSM, который с вами совместно используется, укажите ARN документа SSM.

ExecuteOperationOnScriptFailure -> (булево)

Указывает, должен ли Amazon Data Lifecycle Manager по умолчанию использовать снимки, согласованные по состоянию сбоя, если скрипт до завершился ошибкой.

Чтобы по умолчанию использовать снимки, согласованные по состоянию сбоя, если скрипт до завершился ошибкой, укажите true.
Чтобы пропустить экземпляр для создания снимка, если скрипт до завершился ошибкой, укажите false.

Этот параметр поддерживается только при выполнении скрипта до. Если вы выполняете только скрипт после, опустите этот параметр.

По умолчанию: true

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

Указывает тайм-аут в секундах, после которого Amazon Data Lifecycle Manager завершает попытку выполнения скрипта, если она не завершена. Если скрипт не завершается в течение тайм-аута, Amazon Data Lifecycle Manager завершает попытку. Тайм-аут применяется к скриптам до и после по отдельности.

Если вы автоматизируете резервные копии VSS, опустите этот параметр.

По умолчанию: 10

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

Указывает количество попыток, которые Amazon Data Lifecycle Manager должен предпринять для повторного выполнения скриптов, которые завершились ошибкой.

Если скрипт до завершился ошибкой, Amazon Data Lifecycle Manager повторяет весь процесс создания снимка, включая выполнение скриптов до и после.
Если скрипт после завершился ошибкой, Amazon Data Lifecycle Manager повторяет только скрипт после; в этом случае скрипт до будет завершен, и снимок может быть создан.

Если вы не хотите, чтобы Amazon Data Lifecycle Manager повторял неисправные скрипты, укажите 0.

По умолчанию: 0

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

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

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

Количество снимков, которые нужно сохранить для каждого тома, не более 1000. Например, если вы хотите сохранить не более трех снимков, укажите 3. Когда создается четвертый снимок, самый старый сохраненный снимок удаляется или перемещается в архивный уровень, если вы указали ArchiveRule.

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

Время хранения каждого снимка. Максимальное значение — 100 лет. Это эквивалентно 1200 месяцам, 5200 неделям или 36500 дням.

IntervalUnit -> (строка)

Единица времени для хранения по времени. Например, чтобы сохранить снимки в течение 3 месяцев, укажите Interval=3 и IntervalUnit=MONTHS. После хранения снимка в течение 3 месяцев он удаляется или перемещается в архивный уровень, если вы указали ArchiveRule.

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

[Только политики пользовательских снимков] Правило для включения быстрого восстановления снимков.

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

Количество снимков, которые нужно включить с быстрым восстановлением снимков.

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

Время для включения быстрого восстановления снимков. Максимальное значение — 100 лет. Это эквивалентно 1200 месяцам, 5200 неделям или 36500 дням.

IntervalUnit -> (строка)

Единица времени для включения быстрого восстановления снимков.

AvailabilityZones -> (список)

Зоны доступности, в которых нужно включить быстрое восстановление снимков.

(строка)

CrossRegionCopyRules -> (список)

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

Примечание

Вы не можете указать правила копирования между регионами для политик, создающих снимки на Outpost или в локальной зоне. Если политика создает снимки в регионе, то снимки могут быть скопированы в до трёх регионов или Outpost.

(структура)

[Только пользовательские политики снимков и AMI] Указывает правило копирования снимков и AMI между регионами.

Примечание

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

TargetRegion -> (строка)

Примечание

Используйте этот параметр только для политик AMI. Для политик снимков используйте Target вместо этого. Для политик снимков, созданных до введения параметра Target, этот параметр указывает целевой регион для копирования снимков.

[Только пользовательские политики AMI] Целевой регион или Amazon Resource Name (ARN) целевого Outpost для копирования снимков.

Target -> (строка)

Примечание

Используйте этот параметр только для политик снимков. Для политик AMI используйте TargetRegion.

[Только пользовательские политики снимков] Целевой регион или Amazon Resource Name (ARN) целевого Outpost для копирования снимков.

Encrypted -> (булево)

Чтобы зашифровать копию незашифрованного снимка, если шифрование по умолчанию не включено, включите шифрование с помощью этого параметра. Копии зашифрованных снимков шифруются, даже если этот параметр false или если шифрование по умолчанию не включено.

CmkArn -> (строка)

Amazon Resource Name (ARN) ключа KMS, который будет использоваться для шифрования EBS. Если этот параметр не указан, используется ключ KMS по умолчанию для аккаунта.

CopyTags -> (булево)

Указывает, нужно ли копировать все пользовательские метки из исходного снимка или AMI в копию между регионами.

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

Правило хранения, которое указывает, как долго копии снимков или AMI между регионами будут храниться в целевом регионе.

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

Срок хранения копии снимка или AMI между регионами. Максимальное значение — 100 лет. Это эквивалентно 1200 месяцам, 5200 неделям или 36500 дням.

IntervalUnit -> (строка)

Единица измерения времени для хранения по времени. Например, чтобы сохранить копию между регионами в течение 3 месяцев, укажите Interval=3 и IntervalUnit=MONTHS.

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

[Только пользовательские политики AMI] Правило устаревания AMI для копий AMI между регионами, созданных по правилу.

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

Период после которого копии AMI между регионами будут устаревать. Период должен быть меньше или равен периоду хранения копий AMI между регионами и не может быть больше 10 лет. Это эквивалентно 120 месяцам, 520 неделям или 3650 дням.

IntervalUnit -> (строка)

Единица измерения времени для измерения Interval. Например, чтобы сделать копию AMI между регионами устаревшей через 3 месяца, укажите Interval=3 и IntervalUnit=MONTHS.

ShareRules -> (список)

[Только пользовательские политики снимков] Правило совместного использования снимков с другими аккаунтами Amazon Web Services.

(структура)

[Только пользовательские политики снимков] Указывает правило совместного использования снимков между аккаунтами Amazon Web Services.

TargetAccounts -> (список)

Идентификаторы аккаунтов Amazon Web Services, с которыми нужно поделиться снимками.

(строка)

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

Период после которого снимки, которые были совместно использованы с другими аккаунтами Amazon Web Services, будут автоматически разделены.

UnshareIntervalUnit -> (строка)

Единица измерения времени для автоматического интервала разделения.

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

[Только пользовательские политики AMI] Правило устаревания AMI для расписания.

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

Если расписание имеет правило хранения, основанное на количестве, этот параметр указывает количество самых старых AMI, которые необходимо сделать устаревшими. Количество должно быть меньше или равно количеству хранения расписания и не может быть больше 1000.

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

Если расписание имеет правило хранения, основанное на возрасте, этот параметр указывает период после которого AMIs, созданные по расписанию, должны быть сделаны устаревшими. Период должен быть меньше или равен периоду хранения расписания и не может быть больше 10 лет. Это эквивалентно 120 месяцам, 520 неделям или 3650 дням.

IntervalUnit -> (строка)

Единица измерения времени для измерения Interval.

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

[Только пользовательские политики снимков, которые нацелены только на тома] Правило архивирования снимков для расписания. Когда вы указываете правило архивирования, снимки автоматически перемещаются из стандартного уровня в уровень архива, как только пороговое значение хранения расписания будет достигнуто. Затем снимки сохраняются в уровне архива на срок хранения архива, который вы указываете.

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

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

Информация о периоде хранения для правила архивирования снимков.

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

Информация о периоде хранения в архиве Amazon EBS Snapshots. Дополнительную информацию см. в разделе Архивирование снимков Amazon EBS.

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

Максимальное количество снимков, которые нужно сохранить в уровне хранения архива для каждого тома. Количество должно гарантировать, что каждый снимок сохраняется в уровне архива как минимум 90 дней. Например, если расписание создает снимки каждые 30 дней, вам необходимо указать количество 3 или более, чтобы гарантировать, что каждый снимок архивируется как минимум на 90 дней.

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

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

IntervalUnit -> (строка)

Единица измерения времени для измерения Interval. Например, чтобы сохранить снимки в уровне архива в течение 6 месяцев, укажите Interval=6 и IntervalUnit=MONTHS.

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

[Только пользовательские политики снимков и AMI] Набор дополнительных параметров для политик жизненного цикла снимков и AMI.

Примечание

Если вы изменяете политику, которая была создана или ранее изменена с помощью консоли Amazon Data Lifecycle Manager, вам необходимо включить этот параметр и указать либо значения по умолчанию, либо новые необходимые значения. Вы не можете опустить этот параметр или установить его значения в null.

ExcludeBootVolume -> (булево)

[Только пользовательские политики снимков, нацеленные на экземпляры] Указывает, нужно ли исключать системный том из наборов снимков нескольких томов. По умолчанию false. Если вы укажете true, то системные тома, подключенные к целевым экземплярам, будут исключены из наборов снимков нескольких томов, созданных политикой.

NoReboot -> (булево)

[Только пользовательские политики AMI] Указывает, нужно ли перезагружать целевые экземпляры при запуске политики жизненного цикла. true указывает, что целевые экземпляры не будут перезагружаться при запуске политики. false указывает, что целевые экземпляры будут перезагружены при запуске политики. По умолчанию true (экземпляры не перезагружаются).

ExcludeDataVolumeTags -> (список)

[Только пользовательские политики снимков, нацеленные на экземпляры] Метки, используемые для идентификации данных (несистемных) томов, которые нужно исключить из наборов снимков нескольких томов.

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

(структура)

Указывает метку для ресурса.

Key -> (строка)

Ключ метки.

Value -> (строка)

Значение метки.

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

[Только политики, основанные на событиях] Событие, которое активирует политику, основанную на событиях.

Type -> (строка)

Источник события. В настоящее время поддерживаются только управляемые правила CloudWatch Events.

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

Информация о событии.

EventType -> (строка)

Тип события. В настоящее время поддерживаются только события совместного использования снимков.

SnapshotOwner -> (список)

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

(строка)

DescriptionRegex -> (строка)

Описание снимка, которое может запустить политику. Шаблон описания задается с помощью регулярного выражения. Политика запускается только в том случае, если снимок с описанием, соответствующим указанному шаблону, совместно используется с вашим аккаунтом.

Например, указание ^.*Created for policy: policy-1234567890abcdef0.*$ настраивает политику на запуск только в том случае, если снимки, созданные политикой policy-1234567890abcdef0, совместно используются с вашим аккаунтом.

Actions -> (список)

[Только политики на основе событий] Действия, которые должны выполняться при активации политики на основе событий. Вы можете указать только одно действие на политику.

(структура)

[Только политики на основе событий] Указывает действие для политики на основе событий.

Name -> (строка)

Дескриптивное имя для действия.

CrossRegionCopy -> (список)

Правило для копирования общих снимков между регионами.

(структура)

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

Примечание

Для указания правила копирования между регионами для снимков и AMI-политик используйте CrossRegionCopyRule .

Target -> (строка)

Целевой регион.

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

Параметры шифрования для скопированного снимка.

Encrypted -> (логическое значение)

Чтобы зашифровать копию незашифрованного снимка, когда шифрование по умолчанию не включено, включите шифрование с помощью этого параметра. Копии зашифрованных снимков будут зашифрованы, даже если этот параметр ложный или когда шифрование по умолчанию не включено.

CmkArn -> (строка)

Идентификатор ресурса Amazon (ARN) ключа KMS для шифрования EBS. Если этот параметр не указан, используется ключ KMS по умолчанию для учетной записи.

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

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

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

Срок удержания копии снимка или AMI между регионами. Максимальное значение — 100 лет. Это эквивалентно 1200 месяцам, 5200 неделям или 36500 дням.

IntervalUnit -> (строка)

Единица измерения для удержания на основе времени. Например, чтобы сохранить копию между регионами в течение 3 месяцев, укажите Interval=3 и IntervalUnit=MONTHS .

PolicyLanguage -> (строка)

Тип создаваемой политики. Укажите один из следующих:

SIMPLIFIED Для создания политики по умолчанию.
STANDARD Для создания настраиваемой политики.

ResourceType -> (строка)

[Только политики по умолчанию] Укажите тип политики по умолчанию для создания.

Для создания политики по умолчанию для снимков EBS, которая создаёт снимки всех томов в регионе, у которых нет недавних резервных копий, укажите VOLUME .
Для создания политики по умолчанию для AMI на основе EBS, которая создаёт AMI на основе EBS для всех экземпляров в регионе, у которых нет недавних резервных копий, укажите INSTANCE .

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

[Только политики по умолчанию] Указывает, как часто политика должна запускаться и создавать снимки или AMI. Частота создания может составлять от 1 до 7 дней. Если вы не укажете значение, значение по умолчанию — 1.

По умолчанию: 1

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

[Только политики по умолчанию] Указывает, как долго политика должна хранить снимки или AMI перед их удалением. Период хранения может составлять от 2 до 14 дней, но он должен быть больше частоты создания, чтобы обеспечить хранение по меньшей мере 1 снимка или AMI в любой момент времени. Если вы не укажете значение, значение по умолчанию — 7.

По умолчанию: 7

CopyTags -> (логическое значение)

[Только политики по умолчанию] Указывает, следует ли политике копировать теги из исходного ресурса в снимок или AMI. Если вы не укажете значение, значение по умолчанию — false .

По умолчанию: false

CrossRegionCopyTargets -> (список)

[Только политики по умолчанию] Указывает целевые регионы для копий снимков или AMI. Вы можете указать до 3 целевых регионов. Если вы не хотите создавать копии между регионами, опустите этот параметр.

(структура)

[Только политики по умолчанию] Указывает целевой регион для действий копирования между регионами.

TargetRegion -> (строка)

Целевой регион, например us-east-1 .

ExtendDeletion -> (логическое значение)

[Только политики по умолчанию] Определяет поведение удержания снимков или AMI для политики, если исходный том или экземпляр удалён, или если политика переходит в состояние ошибки, отключена или удалена.

По умолчанию (ExtendDeletion=false ):

Если исходный ресурс удалён, Amazon Data Lifecycle Manager продолжит удалять ранее созданные снимки или AMI, до, но не включая последний, в соответствии с указанным периодом хранения. Если вы хотите, чтобы Amazon Data Lifecycle Manager удалял все снимки или AMI, включая последний, укажите true .
Если политика переходит в состояние ошибки, отключена или удалена, Amazon Data Lifecycle Manager прекращает удаление снимков и AMI. Если вы хотите, чтобы Amazon Data Lifecycle Manager продолжал удалять снимки или AMI, включая последний, если политика переходит в одно из этих состояний, укажите true .

Если вы включите расширенное удаление (ExtendDeletion=true ), вы одновременно переопределяете оба поведения по умолчанию.

Если вы не укажете значение, значение по умолчанию — false .

По умолчанию: false

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

[Только политики по умолчанию] Указывает параметры исключения для томов или экземпляров, для которых вы не хотите создавать снимки или AMI. Политика не будет создавать снимки или AMI для целевых ресурсов, соответствующих указанным параметрам исключения.

ExcludeBootVolumes -> (логическое значение)

[Только политики по умолчанию для снимков EBS] Указывает, следует ли исключать тома, подключённые к экземплярам в качестве загрузочного тома. Если вы исключаете загрузочные тома, только тома, подключённые как данные (не загрузочные), будут резервироваться политикой. Чтобы исключить загрузочные тома, укажите true .

ExcludeVolumeTypes -> (список)

[Только политики по умолчанию для снимков EBS] Указывает типы томов для исключения. Тома указанных типов не будут попадать под действие политики.

(строка)

ExcludeTags -> (список)

[Только политики по умолчанию для AMI на основе EBS] Указывает, следует ли исключать тома, имеющие определённые теги.

(структура)

Указывает тег для ресурса.

Key -> (строка)

Ключ тега.

Value -> (строка)

Значение тега.

Синтаксис JSON:

{
  "PolicyType": "EBS_SNAPSHOT_MANAGEMENT"|"IMAGE_MANAGEMENT"|"EVENT_BASED_POLICY",
  "ResourceTypes": ["VOLUME"|"INSTANCE", ...],
  "ResourceLocations": ["CLOUD"|"OUTPOST"|"LOCAL_ZONE", ...],
  "TargetTags": [
    {
      "Key": "string",
      "Value": "string"
    }
    ...
  ],
  "Schedules": [
    {
      "Name": "string",
      "CopyTags": true|false,
      "TagsToAdd": [
        {
          "Key": "string",
          "Value": "string"
        }
        ...
      ],
      "VariableTags": [
        {
          "Key": "string",
          "Value": "string"
        }
        ...
      ],
      "CreateRule": {
        "Location": "CLOUD"|"OUTPOST_LOCAL"|"LOCAL_ZONE",
        "Interval": integer,
        "IntervalUnit": "HOURS",
        "Times": ["string", ...],
        "CronExpression": "string",
        "Scripts": [
          {
            "Stages": ["PRE"|"POST", ...],
            "ExecutionHandlerService": "AWS_SYSTEMS_MANAGER",
            "ExecutionHandler": "string",
            "ExecuteOperationOnScriptFailure": true|false,
            "ExecutionTimeout": integer,
            "MaximumRetryCount": integer
          }
          ...
        ]
      },
      "RetainRule": {
        "Count": integer,
        "Interval": integer,
        "IntervalUnit": "DAYS"|"WEEKS"|"MONTHS"|"YEARS"
      },
      "FastRestoreRule": {
        "Count": integer,
        "Interval": integer,
        "IntervalUnit": "DAYS"|"WEEKS"|"MONTHS"|"YEARS",
        "AvailabilityZones": ["string", ...]
      },
      "CrossRegionCopyRules": [
        {
          "TargetRegion": "string",
          "Target": "string",
          "Encrypted": true|false,
          "CmkArn": "string",
          "CopyTags": true|false,
          "RetainRule": {
            "Interval": integer,
            "IntervalUnit": "DAYS"|"WEEKS"|"MONTHS"|"YEARS"
          },
          "DeprecateRule": {
            "Interval": integer,
            "IntervalUnit": "DAYS"|"WEEKS"|"MONTHS"|"YEARS"
          }
        }
        ...
      ],
      "ShareRules": [
        {
          "TargetAccounts": ["string", ...],
          "UnshareInterval": integer,
          "UnshareIntervalUnit": "DAYS"|"WEEKS"|"MONTHS"|"YEARS"
        }
        ...
      ],
      "DeprecateRule": {
        "Count": integer,
        "Interval": integer,
        "IntervalUnit": "DAYS"|"WEEKS"|"MONTHS"|"YEARS"
      },
      "ArchiveRule": {
        "RetainRule": {
          "RetentionArchiveTier": {
            "Count": integer,
            "Interval": integer,
            "IntervalUnit": "DAYS"|"WEEKS"|"MONTHS"|"YEARS"
          }
        }
      }
    }
    ...
  ],
  "Parameters": {
    "ExcludeBootVolume": true|false,
    "NoReboot": true|false,
    "ExcludeDataVolumeTags": [
      {
        "Key": "string",
        "Value": "string"
      }
      ...
    ]
  },
  "EventSource": {
    "Type": "MANAGED_CWE",
    "Parameters": {
      "EventType": "shareSnapshot",
      "SnapshotOwner": ["string", ...],
      "DescriptionRegex": "string"
    }
  },
  "Actions": [
    {
      "Name": "string",
      "CrossRegionCopy": [
        {
          "Target": "string",
          "EncryptionConfiguration": {
            "Encrypted": true|false,
            "CmkArn": "string"
          },
          "RetainRule": {
            "Interval": integer,
            "IntervalUnit": "DAYS"|"WEEKS"|"MONTHS"|"YEARS"
          }
        }
        ...
      ]
    }
    ...
  ],
  "PolicyLanguage": "SIMPLIFIED"|"STANDARD",
  "ResourceType": "VOLUME"|"INSTANCE",
  "CreateInterval": integer,
  "RetainInterval": integer,
  "CopyTags": true|false,
  "CrossRegionCopyTargets": [
    {
      "TargetRegion": "string"
    }
    ...
  ],
  "ExtendDeletion": true|false,
  "Exclusions": {
    "ExcludeBootVolumes": true|false,
    "ExcludeVolumeTypes": ["string", ...],
    "ExcludeTags": [
      {
        "Key": "string",
        "Value": "string"
      }
      ...
    ]
  }
}

--tags (словарь)

Теги, которые нужно применить к политике жизненного цикла при её создании.

key -> (строка)

value -> (строка)

Краткая запись:

KeyName1=string,KeyName2=string

Синтаксис JSON:

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

--default-policy (строка)

[Только политики по умолчанию] Укажите тип политики по умолчанию для создания.

Для создания политики по умолчанию для снимков EBS, которая создаёт снимки всех томов в регионе, у которых нет недавних резервных копий, укажите VOLUME .
Для создания политики по умолчанию для AMI на основе EBS, которая создаёт AMI на основе EBS для всех экземпляров в регионе, у которых нет недавних резервных копий, укажите INSTANCE .

Возможные значения:

VOLUME
INSTANCE

--create-interval (целое число)

По умолчанию: 1

--retain-interval (целое число)

По умолчанию: 7

--copy-tags | --no-copy-tags (логическое значение)

По умолчанию: false

--extend-deletion | --no-extend-deletion (логическое значение)

По умолчанию (ExtendDeletion=false ):

Если исходный ресурс удалён, Amazon Data Lifecycle Manager продолжит удалять ранее созданные снимки или AMI, до, но не включая последний, в соответствии с указанным периодом хранения. Если вы хотите, чтобы Amazon Data Lifecycle Manager удалял все снимки или AMI, включая последний, укажите true .
Если политика переходит в состояние ошибки, отключена или удалена, Amazon Data Lifecycle Manager прекращает удаление снимков и AMI. Если вы хотите, чтобы Amazon Data Lifecycle Manager продолжал удалять снимки или AMI, включая последний, если политика переходит в одно из этих состояний, укажите true .

Если вы не укажете значение, значение по умолчанию — false .

По умолчанию: false

--cross-region-copy-targets (список)

(структура)

[Только политики по умолчанию] Указывает целевой регион для действий копирования между регионами.

TargetRegion -> (строка)

Целевой регион, например us-east-1 .

Краткая запись:

TargetRegion=string ...

Синтаксис JSON:

[
  {
    "TargetRegion": "string"
  }
  ...
]

--exclusions (структура)

[Только политики по умолчанию] Указывает параметры исключения для томов или экземпляров, для которых вы не хотите создавать снимки или AMI. Политика не будет создавать снимки или AMI для целевых ресурсов, которые соответствуют любым из указанных параметров исключения.

ExcludeBootVolumes -> (boolean)

[Политики по умолчанию только для снимков EBS] Указывает, следует ли исключить тома, подключенные к экземплярам в качестве системного тома. Если вы исключаете системные тома, только тома, подключенные в качестве данных (не системных) томов, будут резервироваться политикой. Чтобы исключить системные тома, укажите true .

ExcludeVolumeTypes -> (list)

[Политики по умолчанию только для снимков EBS] Указывает типы томов для исключения. Тома указанных типов не будут являться целью политики.

(string)

ExcludeTags -> (list)

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

(structure)

Указывает тег для ресурса.

Key -> (string)

Ключ тега.

Value -> (string)

Значение тега.

Сокращенная синтаксическая запись:

ExcludeBootVolumes=boolean,ExcludeVolumeTypes=string,string,ExcludeTags=[{Key=string,Value=string},{Key=string,Value=string}]

Синтаксис JSON:

{
  "ExcludeBootVolumes": true|false,
  "ExcludeVolumeTypes": ["string", ...],
  "ExcludeTags": [
    {
      "Key": "string",
      "Value": "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 (строка)

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

--no-verify-ssl (boolean)

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

--no-paginate (boolean)

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

--output (строка)

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

json
text
table
yaml
yaml-stream

--query (строка)

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

--profile (строка)

Использовать определённый профиль из файла учетных данных.

--region (строка)

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

--version (строка)

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

--color (строка)

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

on
off
auto

--no-sign-request (boolean)

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

--ca-bundle (строка)

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

--cli-read-timeout (int)

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

--cli-connect-timeout (int)

Максимальное время подключения сокета в секундах. Если значение установлено в 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 (boolean)

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

--cli-auto-prompt (boolean)

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

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

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

Примеры

Примечание

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

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

Для создания политики жизненного цикла

Следующий пример создания create-lifecycle-policy политики жизненного цикла, которая создаёт ежедневный снимок томов в указанное время. Указанные теги добавляются к снимкам, а теги также копируются из тома и добавляются к снимкам. Если создание нового снимка превышает указанное максимальное количество, самый старый снимок удаляется.

aws dlm create-lifecycle-policy \
    --description "My first policy" \
    --state ENABLED \
    --execution-role-arn arn:aws:iam::12345678910:role/AWSDataLifecycleManagerDefaultRole \
    --policy-details file://policyDetails.json

Содержимое policyDetails.json:

{
    "ResourceTypes": [
        "VOLUME"
    ],
    "TargetTags": [
        {
            "Key": "costCenter",
            "Value": "115"
        }
    ],
    "Schedules":[
        {
            "Name": "DailySnapshots",
            "CopyTags": true,
            "TagsToAdd": [
                {
                    "Key": "type",
                     "Value": "myDailySnapshot"
                }
            ],
            "CreateRule": {
                "Interval": 24,
                "IntervalUnit": "HOURS",
                "Times": [
                    "03:00"
                ]
            },
            "RetainRule": {
                "Count":5
            }
        }
    ]
}

Вывод:

{
    "PolicyId": "policy-0123456789abcdef0"
}

Вывод

PolicyId -> (строка)

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