Spec-Zone.ru › AWS CLI v2

[ aws . ec2 ]

register-instance-event-notification-attributes

Описание

Регистрирует набор ключей тегов для включения в запланированные уведомления о событиях для ваших ресурсов.

Чтобы удалить теги, используйте DeregisterInstanceEventNotificationAttributes.

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

Синтаксис

  register-instance-event-notification-attributes
[--dry-run | --no-dry-run]
--instance-tag-attribute <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]

Параметры

--dry-run | --no-dry-run (boolean)

Проверяет, есть ли у вас необходимые разрешения для действия, не отправляя фактический запрос, и предоставляет ответ об ошибке. Если у вас есть необходимые разрешения, ответ об ошибке — DryRunOperation. В противном случае — UnauthorizedOperation.

--instance-tag-attribute (структура)

Информация о ключах тегов для регистрации.

IncludeAllTagsOfInstance -> (boolean)

Указывает, нужно ли регистрировать все ключи тегов в текущем регионе. Укажите true, чтобы зарегистрировать все ключи тегов.

InstanceTagKeys -> (список)

Ключи тегов для регистрации.

(строка)

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

IncludeAllTagsOfInstance=boolean,InstanceTagKeys=string,string

Синтаксис JSON:

{
  "IncludeAllTagsOfInstance": true|false,
  "InstanceTagKeys": ["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-auto-prompt (boolean)

Автоматический запрос параметров CLI.

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

Отключение автоматического запроса параметров CLI.

Примеры

Примечание

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

Если не указано иное, во всех примерах используются правила цитирования, подобные unix. Эти примеры необходимо адаптировать к правилам цитирования вашей оболочки терминала. См. использование кавычек со строками в руководстве пользователя AWS CLI.

Пример 1: Включение всех тегов в уведомлениях о событиях

Следующий register-instance-event-notification-attributes пример включает все теги в уведомлениях о событиях.

aws ec2 register-instance-event-notification-attributes \
    --instance-tag-attribute IncludeAllTagsOfInstance=true

Вывод:

{
    "InstanceTagAttribute": {
        "InstanceTagKeys": [],
        "IncludeAllTagsOfInstance": true
    }
}

Дополнительную информацию см. в разделе «Запланированные события для ваших экземпляров» в руководстве пользователя Amazon EC2.

Пример 2: Включение определенных тегов в уведомлениях о событиях

В следующем register-instance-event-notification-attributes примере включаются указанные теги в уведомлениях о событиях. Вы не можете указать теги, если IncludeAllTagsOfInstance равно true.

aws ec2 register-instance-event-notification-attributes \
    --instance-tag-attribute InstanceTagKeys="tag-key1","tag-key2"

Вывод:

{
    "InstanceTagAttribute": {
        "InstanceTagKeys": [
            "tag-key1",
            "tag-key2"
        ],
        "IncludeAllTagsOfInstance": false
    }
}

Дополнительную информацию см. в разделе «Запланированные события для ваших экземпляров» в руководстве пользователя Amazon EC2.

Вывод

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

Результат набора ключей тегов.

InstanceTagKeys -> (список)

Зарегистрированные ключи тегов.

(строка)

IncludeAllTagsOfInstance -> (boolean)

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

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

Spec-Zone.ru

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