Spec-Zone.ru › AWS CLI v2

[ aws . rbin ]

update-rule

Описание

Обновляет существующее правило удержания корзины переработки. Вы можете обновить описание правила удержания, теги ресурсов и период удержания в любое время после создания. Вы не можете обновить тип ресурса правила удержания после создания. Дополнительную информацию см. в разделе Обновление правил удержания корзины переработки в руководстве пользователя Amazon Elastic Compute Cloud.

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

Синтаксис

  update-rule
--identifier <value>
[--retention-period <value>]
[--description <value>]
[--resource-type <value>]
[--resource-tags <value>]
[--exclude-resource-tags <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]

Параметры

--identifier (строка)

Уникальный идентификатор правила удержания.

--retention-period (структура)

Информация о периоде удержания, в течение которого правило удержания должно удерживать ресурсы.

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

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

RetentionPeriodUnit -> (строка)

Единица измерения периода удержания. В настоящее время поддерживается только DAYS.

Сокращенный синтаксис:

RetentionPeriodValue=integer,RetentionPeriodUnit=string

Синтаксис JSON:

{
  "RetentionPeriodValue": integer,
  "RetentionPeriodUnit": "DAYS"
}

--description (строка)

Описание правила удержания.

--resource-type (строка)

Примечание

В настоящее время этот параметр не поддерживается. Вы не можете обновить тип ресурса правила удержания после создания.

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

  • EBS_SNAPSHOT
  • EC2_IMAGE

--resource-tags (список)

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

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

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

(структура)

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

ResourceTagKey -> (строка)

Ключ тега.

ResourceTagValue -> (строка)

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

Сокращенный синтаксис:

ResourceTagKey=string,ResourceTagValue=string ...

Синтаксис JSON:

[
  {
    "ResourceTagKey": "string",
    "ResourceTagValue": "string"
  }
  ...
]

--exclude-resource-tags (список)

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

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

(структура)

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

ResourceTagKey -> (строка)

Ключ тега.

ResourceTagValue -> (строка)

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

Сокращенный синтаксис:

ResourceTagKey=string,ResourceTagValue=string ...

Синтаксис JSON:

[
  {
    "ResourceTagKey": "string",
    "ResourceTagValue": "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 (логическое значение)

Включает отладочную запись в журнал.

--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-auto-prompt (логическое значение)

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

--no-cli-auto-prompt (логическое значение)

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

Вывод

Identifier -> (строка)

Уникальный идентификатор правила удержания.

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

Информация о периоде удержания, в течение которого правило удержания должно удерживать ресурсы.

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

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

RetentionPeriodUnit -> (строка)

Единица измерения периода удержания. В настоящее время поддерживается только DAYS.

Description -> (строка)

Описание правила удержания.

ResourceType -> (строка)

Тип ресурса, сохраняемый правилом удержания.

ResourceTags -> (список)

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

(структура)

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

ResourceTagKey -> (строка)

Ключ тега.

ResourceTagValue -> (строка)

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

Status -> (строка)

Состояние правила удержания. Только правила удержания в состоянии available сохраняют ресурсы.

LockState -> (строка)

[Только правила удержания на уровне региона] Состояние блокировки для правила удержания.

  • locked - Правило удержания заблокировано и не может быть изменено или удалено.
  • pending_unlock - Правило удержания было разблокировано, но все еще находится в период ожидания разблокировки. Правило удержания может быть изменено или удалено только после истечения периода ожидания разблокировки.
  • unlocked - Правило удержания разблокировано и может быть изменено или удалено любым пользователем с необходимыми разрешениями.
  • null - Правило удержания никогда не блокировалось. После блокировки правила удержания оно может переходить только между состояниями locked и unlocked; оно никогда не может вернуться в состояние null .

LockEndTime -> (временная метка)

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

RuleArn -> (строка)

Amazon Resource Name (ARN) правила удержания.

ExcludeResourceTags -> (список)

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

(структура)

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

ResourceTagKey -> (строка)

Ключ тега.

ResourceTagValue -> (строка)

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

© Copyright 2025, Amazon Web Services. Created using Sphinx.

Spec-Zone.ru

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