get-lifecycle-policy
Описание
Получает подробную информацию о заданном правиле жизненного цикла.
См. также: Документацию API AWS
Синтаксис
get-lifecycle-policy
--policy-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]
Параметры
--policy-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-lifecycle-policy пример отображает подробности для указанного правила жизненного цикла.
aws dlm get-lifecycle-policy \
--policy-id policy-0123456789abcdef0
Вывод:
{
"Policy": {
"PolicyId": "policy-0123456789abcdef0",
"Description": "My policy",
"State": "ENABLED",
"ExecutionRoleArn": "arn:aws:iam::123456789012:role/AWSDataLifecycleManagerDefaultRole",
"DateCreated": "2019-08-08T17:45:42Z",
"DateModified": "2019-08-08T17:45:42Z",
"PolicyDetails": {
"PolicyType": "EBS_SNAPSHOT_MANAGEMENT",
"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 -> (строка)
Описание -> (строка)
Состояние -> (строка)
Сообщение о статусе -> (строка)
ExecutionRoleArn -> (строка)
Дата создания -> (метка времени)
Дата изменения -> (метка времени)
PolicyDetails -> (структура)
Настройка правила жизненного цикла
PolicyType -> (строка)
Тип правила. Укажите EBS_SNAPSHOT_MANAGEMENT, чтобы создать правило жизненного цикла, управляющее жизненным циклом снимков Amazon EBS. Укажите IMAGE_MANAGEMENT, чтобы создать правило жизненного цикла, управляющее жизненным циклом AMIs на основе EBS. Укажите EVENT_BASED_POLICY, чтобы создать правило на основе событий, выполняющее определенные действия при возникновении определенного события в вашей учетной записи Amazon Web Services.
По умолчанию — EBS_SNAPSHOT_MANAGEMENT.
ResourceTypes -> (список)
VOLUME, чтобы создавать снимки отдельных томов, или используйте INSTANCE, чтобы создавать снимки нескольких томов из томов для экземпляра.(строка)
ResourceLocations -> (список)
- Если исходные ресурсы находятся в регионе, укажите
CLOUD. В этом случае политика затрагивает все ресурсы указанного типа с соответствующими тегами во всех зонах доступности в регионе. -
[Только правила пользовательских снимков] Если исходные ресурсы находятся в локальной зоне, укажите
LOCAL_ZONE. В этом случае политика затрагивает все ресурсы указанного типа с соответствующими тегами во всех локальных зонах в регионе. - Если исходные ресурсы находятся на Outpost в вашей учетной записи, укажите
OUTPOST. В этом случае политика затрагивает все ресурсы указанного типа с соответствующими тегами на всех Outpost в вашей учетной записи.
(строка)
TargetTags -> (список)
(структура)
Указывает тег для ресурса.
Ключ -> (строка)
Значение -> (строка)
Schedules -> (список)
(структура)
Name -> (строка)
CopyTags -> (логическое значение)
TagsToAdd -> (список)
Теги, которые следует применить к ресурсам, созданным политикой. Эти пользовательские теги дополняют теги жизненного цикла, добавленные Amazon Web Services.
(структура)
Определяет тег для ресурса.
Key -> (строка)
Value -> (строка)
VariableTags -> (список)
$(instance-id) или $(timestamp). Переменные теги допустимы только для управления моментальными снимками EBS — политики экземпляров.(структура)
Определяет тег для ресурса.
Key -> (строка)
Value -> (строка)
CreateRule -> (структура)
Правило создания.
Location -> (строка)
- Если политика нацелена на ресурсы в Регионе, то моментальные снимки необходимо создавать в том же Регионе, что и исходный ресурс.
- Если политика нацелена на ресурсы в Локальной зоне, вы можете создать моментальные снимки в той же Локальной зоне или в её родительском Регионе.
- Если политика нацелена на ресурсы на Outpost, то вы можете создать моментальные снимки на том же Outpost или в его родительском Регионе.
Укажите одно из следующих значений:
- Чтобы создать моментальные снимки в том же Регионе, что и исходный ресурс, укажите
CLOUD. - Чтобы создать моментальные снимки в той же Локальной зоне, что и исходный ресурс, укажите
LOCAL_ZONE. - Чтобы создать моментальные снимки на том же Outpost, что и исходный ресурс, укажите
OUTPOST_LOCAL.
По умолчанию: CLOUD
Interval -> (целое число)
IntervalUnit -> (строка)
Times -> (список)
Время начала операции в формате UTC. Поддерживаемый формат hh:mm.
Операция выполняется в течение одного часа после указанного времени. Если вы не указываете время, Amazon Data Lifecycle Manager выбирает время в течение следующих 24 часов.
(строка)
CronExpression -> (строка)
Scripts -> (список)
Для получения дополнительной информации см. Автоматизацию моментальных снимков, согласованных с приложением, с помощью скриптов до и после.
(структура)
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 автоматически использует документ SSMAWSEC2-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 -> (целое число)
3. Когда создаётся четвёртый моментальный снимок, самый старый сохранённый моментальный снимок удаляется или перемещается в уровень архива, если вы указали ArchiveRule.Interval -> (целое число)
IntervalUnit -> (строка)
Interval=3 и IntervalUnit=MONTHS. После истечения 3 месяцев моментальный снимок удаляется или перемещается в уровень архива, если вы указали ArchiveRule.FastRestoreRule -> (структура)
Count -> (целое число)
Interval -> (целое число)
IntervalUnit -> (строка)
AvailabilityZones -> (список)
Зоны доступности, в которых необходимо включить быстрое восстановление моментальных снимков.
(строка)
CrossRegionCopyRules -> (список)
Указывает правило для копирования снимков или AMIs между регионами.
Примечание
Вы не можете указать правила копирования между регионами для политик, создающих снимки на Outpost или в локальной зоне. Если политика создает снимки в регионе, то снимки могут быть скопированы в до трех регионов или Outpost.(структура)
Примечание
Для указания действия копирования между регионами для политик на основе событий используйте CrossRegionCopyAction .TargetRegion -> (строка)
Примечание
[Только пользовательские политики AMI] Целевой регион или Amazon Resource Name (ARN) целевого Outpost для копий снимков.
Target -> (строка)
Примечание
[Только пользовательские политики снимков] Целевой регион или Amazon Resource Name (ARN) целевого Outpost для копий снимков.
Encrypted -> (булево)
CmkArn -> (строка)
CopyTags -> (булево)
RetainRule -> (структура)
Правило хранения, указывающее, как долго копии снимков или AMI между регионами должны храниться в целевом регионе.
Interval -> (целое число)
IntervalUnit -> (строка)
Interval=3 и IntervalUnit=MONTHS .DeprecateRule -> (структура)
Interval -> (целое число)
IntervalUnit -> (строка)
Interval=3 и IntervalUnit=MONTHS .ShareRules -> (список)
(структура)
TargetAccounts -> (список)
Идентификаторы учетных записей Amazon Web Services, с которыми нужно поделиться снимками.
(строка)
UnshareInterval -> (целое число)
UnshareIntervalUnit -> (строка)
DeprecateRule -> (структура)
Count -> (целое число)
Interval -> (целое число)
IntervalUnit -> (строка)
ArchiveRule -> (структура)
Дополнительную информацию об использовании архивирования снимков см. в разделе Учет при использовании политик жизненного цикла снимков .
RetainRule -> (структура)
Информация о периоде хранения для правила архивирования снимков.
RetentionArchiveTier -> (структура)
Информация о периоде хранения в архиве Amazon EBS Snapshots. Дополнительную информацию см. в разделе Архивирование снимков Amazon EBS .
Count -> (целое число)
Interval -> (целое число)
IntervalUnit -> (строка)
Interval=6 и IntervalUnit=MONTHS .Parameters -> (структура)
Примечание
Если вы изменяете политику, которая была создана или ранее изменена с помощью консоли Amazon Data Lifecycle Manager, необходимо включить этот параметр и указать либо значения по умолчанию, либо новые требуемые значения. Вы не можете опустить этот параметр или установить его значения в null.ExcludeBootVolume -> (булево)
false . Если вы укажете true , то системные тома, подключенные к целевым экземплярам, будут исключены из наборов снимков нескольких томов, созданных политикой.NoReboot -> (булево)
true указывает, что целевые экземпляры не перезагружаются при запуске политики. false указывает, что целевые экземпляры перезагружаются при запуске политики. По умолчанию значение true (экземпляры не перезагружаются).ExcludeDataVolumeTags -> (список)
Если вы создаете политику жизненного цикла снимков, которая нацелена на экземпляры, и вы указываете теги для этого параметра, то данные тома с указанными тегами, подключенные к целевым экземплярам, будут исключены из наборов снимков нескольких томов, созданных политикой.
(структура)
Указывает тег для ресурса.
Key -> (строка)
Value -> (строка)
EventSource -> (структура)
Type -> (строка)
Parameters -> (структура)
Информация о событии.
EventType -> (строка)
SnapshotOwner -> (список)
Идентификаторы учетных записей Amazon Web Services, которые могут запускать политику, совместно используя снимки со своей учетной записью. Политика запускается только в том случае, если одна из указанных учетных записей Amazon Web Services разделяет снимок со вашей учетной записью.
(строка)
DescriptionRegex -> (строка)
Описание снимка, которое может запустить политику. Шаблон описания указан с использованием регулярного выражения. Политика запускается только в том случае, если снимок с описанием, соответствующим указанному шаблону, совместно используется с вашей учетной записью.
Например, указание ^.*Created for policy: policy-1234567890abcdef0.*$ настраивает политику таким образом, что она запускается только если снимки, созданные политикой policy-1234567890abcdef0, совместно используются с вашей учетной записью.
Actions -> (список)
(структура)
Имя -> (строка)
CrossRegionCopy -> (список)
Правило для копирования общих снимков между регионами.
(структура)
Примечание
Чтобы указать правило копирования между регионами для политики снимков и AMI, используйте CrossRegionCopyRule.Цель -> (строка)
EncryptionConfiguration -> (структура)
Настройки шифрования для скопированного снимка.
Зашифровано -> (булево)
CmkArn -> (строка)
RetainRule -> (структура)
Указывает правило хранения для копий снимков между регионами, созданных политиками снимков или политиками на основе событий, или копий AMI между регионами, созданных политиками AMI. По истечении срока хранения копия между регионами удаляется.
Интервал -> (целое число)
IntervalUnit -> (строка)
Interval=3 и IntervalUnit=MONTHS.PolicyLanguage -> (строка)
Тип политики для создания. Укажите один из следующих:
-
SIMPLIFIEDДля создания политики по умолчанию. -
STANDARDДля создания пользовательской политики.
ResourceType -> (строка)
- Чтобы создать политику по умолчанию для снимков EBS, которая создает снимки всех томов в регионе, у которых нет недавних резервных копий, укажите
VOLUME. - Чтобы создать политику по умолчанию для AMI с поддержкой EBS, которая создает AMI с поддержкой EBS из всех экземпляров в регионе, у которых нет недавних резервных копий, укажите
INSTANCE.
CreateInterval -> (целое число)
По умолчанию: 1
RetainInterval -> (целое число)
По умолчанию: 7
CopyTags -> (булево)
false.По умолчанию: false
CrossRegionCopyTargets -> (список)
(структура)
TargetRegion -> (строка)
us-east-1.ExtendDeletion -> (булево)
По умолчанию (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 -> (структура)
ExcludeBootVolumes -> (булево)
true.ExcludeVolumeTypes -> (список)
(строка)
ExcludeTags -> (список)
(структура)
Указывает метку для ресурса.
Ключ -> (строка)
Значение -> (строка)
Tags -> (карта)
Метки.
ключ -> (строка)
значение -> (строка)
PolicyArn -> (строка)
DefaultPolicy -> (булево)
Указывает, является ли политика политикой жизненного цикла по умолчанию или пользовательской политикой жизненного цикла.
-
true- политика является политикой по умолчанию. -
false- политика является пользовательской политикой.
© Copyright 2025, Amazon Web Services. Created using Sphinx.