Spec-Zone.ru › AWS CLI v2

[ aws . secretsmanager ]

Добавление тегов к секрету

Описание

Прикрепляет теги к секрету. Теги состоят из имени ключа и значения. Теги являются частью метаданных секрета. Они не связаны со специфическими версиями секрета. Данная операция добавляет теги к существующему списку тегов.

Сведения о квотах на теги и ограничениях по именованию см. в разделе «Квоты служб для тегирования» в руководстве Amazon Web Services General Reference.

Предупреждение

Если вы используете теги в качестве части вашей стратегии безопасности, добавление или удаление тега может изменить разрешения. Если успешное выполнение этой операции приведёт к потере разрешений на этот секрет, операция заблокируется и вернёт ошибку «Доступ запрещён».

Управление секретами генерирует запись журнала CloudTrail при вызове данного действия. Не включайте конфиденциальную информацию в параметры запроса, так как она может быть залогирована. Дополнительную информацию см. в разделе «Регистрация событий управления секретами с помощью CloudTrail».

Требуемые разрешения: secretsmanager:TagResource . Дополнительную информацию см. в разделах «Действия политики IAM для управления секретами» и «Аутентификация и контроль доступа в управлении секретами».

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

Синтаксис

  tag-resource
--secret-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]

Параметры

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

Идентификатор секрета, к которому необходимо прикрепить теги. Вы можете указать либо Amazon Resource Name (ARN), либо дружественное имя секрета.

Для ARN рекомендуется указывать полное ARN, а не частичное. См. «Поиск секрета по частичному ARN».

--tags (список)

Теги для прикрепления к секрету в виде аргумента JSON-строки. Каждый элемент в списке состоит из Key и Value.

Для хранения нескольких значений рекомендуется использовать аргумент JSON-строки и указывать пары ключ/значение. Дополнительную информацию см. в разделе «Указание значений параметров для командной строки Amazon Web Services» в руководстве пользователя командной строки Amazon Web Services.

(структура)

Структура, содержащая информацию о теге.

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

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

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

Строковое значение, связанное с ключом тега.

Краткая форма синтаксиса:

Key=string,Value=string ...

Синтаксис JSON:

[
  {
    "Key": "string",
    "Value": "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 для вывода.

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

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

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

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

Примеры

Примечание

Для использования следующих примеров необходимо установить и настроить AWS CLI. Дополнительную информацию см. в руководстве «Начало работы» в Руководстве пользователя AWS CLI.

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

Пример 1: Добавление тега к секрету

Следующий пример демонстрирует, как прикрепить тег с помощью краткого синтаксиса.

aws secretsmanager tag-resource \
    --secret-id MyTestSecret \
    --tags Key=FirstTag,Value=FirstValue

Эта команда не выводит ничего на экран.

Дополнительную информацию см. в разделе «Тегирование ваших секретов» в Руководстве пользователя управления секретами.

Пример 2: Добавление нескольких тегов к секрету

Следующий пример демонстрирует, как прикрепить два тега ключ-значение к секрету.

aws secretsmanager tag-resource \
    --secret-id MyTestSecret \
    --tags '[{"Key": "FirstTag", "Value": "FirstValue"}, {"Key": "SecondTag", "Value": "SecondValue"}]'

Эта команда не выводит ничего на экран.

Дополнительную информацию см. в разделе «Тегирование секретов» в Руководстве пользователя управления секретами.

Вывод

Отсутствует.

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

Spec-Zone.ru

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