tag-resource

Описание

Добавляет или изменяет метки на управляемом клиентом ключе .

Каждая метка состоит из ключа метки и значения метки, которые являются строками, чувствительными к регистру. Значение метки может быть пустой (нулевой) строкой. Чтобы добавить метку, укажите новый ключ метки и значение метки. Чтобы изменить метку, укажите существующий ключ метки и новое значение метки.

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

Вы также можете добавлять метки к ключу KMS при его создании ( CreateKey ) или репликации ( ReplicateKey ).

Дополнительную информацию об использовании меток в KMS см. в разделе Помечение ключей . Дополнительную общую информацию о метках, включая формат и синтаксис, см. в разделе Помещение меток на ресурсы Amazon Web Services в Общей справке Amazon Web Services .

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

• CreateKey
• ListResourceTags
• ReplicateKey
• UntagResource

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

Синтаксис

  tag-resource
--key-id <value>
--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]

Параметры

--key-id (строка)

--tags (список)

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

TagKey=string,TagValue=string ...

Синтаксис JSON:

[
  {
    "TagKey": "string",
    "TagValue": "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
• текст
• таблица
• yaml
• yaml-поток

--query (строка)

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

--profile (строка)

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

--region (строка)

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

--version (строка)

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

--color (строка)

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

• вкл
• выкл
• авто

--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.

Примеры

Добавление метки к ключу KMS

В следующем примере tag-resource добавляются метки "Purpose":"Test" и "Dept":"IT" к управляемому клиентом ключу KMS. Такие метки можно использовать для маркировки ключей KMS и создания категорий ключей KMS для разрешений и аудита.

Для указания ключа KMS используйте параметр key-id. В этом примере используется значение идентификатора ключа, но в этой команде вы можете использовать идентификатор ключа или ARN ключа.

aws kms tag-resource \
    --key-id 1234abcd-12ab-34cd-56ef-1234567890ab \
    --tags TagKey='Purpose',TagValue='Test' TagKey='Dept',TagValue='IT'

Эта команда не генерирует вывод. Чтобы просмотреть метки на ключе AWS KMS KMS, используйте команду list-resource-tags.

Дополнительную информацию об использовании меток в AWS KMS см. в разделе Помечение ключей в Руководстве разработчика службы управления ключами AWS.

Вывод

Нет