Spec-Zone.ru › AWS CLI v2

[ aws . rbin ]

create-rule

Описание

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

  • Правила удержания на уровне тегов - Эти правила удержания используют теги ресурсов для идентификации ресурсов, которые необходимо защитить. Для каждого правила удержания вы указываете одну или несколько пар ключей и значений тегов. Ресурсы (указанного типа), которые имеют хотя бы одну из этих пар ключ-значение тегов, автоматически сохраняются в корзине переработки при удалении. Используйте этот тип правила удержания для защиты конкретных ресурсов в вашем аккаунте на основе их тегов.
  • Правила удержания на уровне региона - Эти правила удержания по умолчанию применяются ко всем ресурсам (указанного типа) в регионе, даже если ресурсы не помечены тегами. Однако вы можете указать исключающие теги, чтобы исключить ресурсы, которые имеют определенные теги. Используйте этот тип правила удержания для защиты всех ресурсов определенного типа в регионе.

Дополнительную информацию см. в разделе Создание правил удержания корзины переработки в Руководстве пользователя Amazon EBS.

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

Синтаксис

  create-rule
--retention-period <value>
[--description <value>]
[--tags <value>]
--resource-type <value>
[--resource-tags <value>]
[--lock-configuration <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]

Параметры

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

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

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

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

RetentionPeriodUnit -> (строка)

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

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

RetentionPeriodValue=integer,RetentionPeriodUnit=string

Синтаксис JSON:

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

--description (строка)

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

--tags (список)

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

(структура)

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

Key -> (строка)

Ключ тега.

Value -> (строка)

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

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

Key=string,Value=string ...

Синтаксис JSON:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

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

Тип ресурса, который должно удерживать правило удержания. В настоящее время поддерживаются только снимки Amazon EBS и образы AMIs с поддержкой EBS. Для сохранения снимков укажите EBS_SNAPSHOT. Для сохранения образов AMIs с поддержкой EBS укажите EC2_IMAGE.

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

  • EBS_SNAPSHOT
  • EC2_IMAGE

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

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

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

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

(структура)

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

ResourceTagKey -> (строка)

Ключ тега.

ResourceTagValue -> (строка)

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

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

ResourceTagKey=string,ResourceTagValue=string ...

Синтаксис JSON:

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

--lock-configuration (структура)

Информация о конфигурации блокировки правила удержания.

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

Информация о задержке разблокировки правила удержания.

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

Период задержки разблокировки, измеряемый в единицах, указанных для UnlockDelayUnit.

UnlockDelayUnit -> (строка)

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

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

UnlockDelay={UnlockDelayValue=integer,UnlockDelayUnit=string}

Синтаксис JSON:

{
  "UnlockDelay": {
    "UnlockDelayValue": integer,
    "UnlockDelayUnit": "DAYS"
  }
}

--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
  • таблица
  • yaml
  • yaml-поток

--query (строка)

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

--profile (строка)

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

--region (строка)

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

--version (строка)

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

--color (строка)

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

  • включено
  • выключено
  • автоматически

--no-sign-request (булево)

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

--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 (булево)

Отключить пагинатор cli для вывода.

--cli-auto-prompt (булево)

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

--no-cli-auto-prompt (булево)

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

Вывод

Идентификатор -> (строка)

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

Срок хранения -> (структура)

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

Значение срока хранения -> (целое число)

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

Единица срока хранения -> (строка)

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

Описание -> (строка)

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

Теги -> (список)

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

(структура)

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

Ключ -> (строка)

Ключ тега.

Значение -> (строка)

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

Тип ресурса -> (строка)

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

Теги ресурсов -> (список)

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

(структура)

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

Ключ тега ресурса -> (строка)

Ключ тега.

Значение тега ресурса -> (строка)

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

Статус -> (строка)

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

Настройка блокировки -> (структура)

Информация о настройке блокировки правила удержания.

Задержка разблокировки -> (структура)

Информация о задержке разблокировки правила удержания.

Значение задержки разблокировки -> (целое число)

Период задержки разблокировки, измеряемый в единицах, указанных для Единицы задержки разблокировки.

Единица задержки разблокировки -> (строка)

Единица времени, в которой измеряется задержка разблокировки. В настоящее время задержка разблокировки может измеряться только в днях.

Состояние блокировки -> (строка)

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

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

RuleArn -> (строка)

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

Исключенные теги ресурсов -> (список)

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

(структура)

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

Ключ тега ресурса -> (строка)

Ключ тега.

Значение тега ресурса -> (строка)

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

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

Spec-Zone.ru

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