обновить-псевдоним

Описание

Привязывает существующий псевдоним KMS к другому ключу KMS. Каждый псевдоним связан только с одним ключом KMS одновременно, хотя один ключ KMS может иметь несколько псевдонимов. Псевдоним и ключ KMS должны находиться в одной учетной записи Amazon Web Services и одной Регионе.

Текущий и новый ключи KMS должны быть одного типа (оба симметричные или оба асимметричные или оба HMAC) и иметь одинаковое использование ключа. Это ограничение предотвращает ошибки в коде, использующем псевдонимы. Если вам необходимо назначить псевдоним ключу KMS другого типа, используйте DeleteAlias для удаления старого псевдонима и CreateAlias для создания нового псевдонима.

Вы не можете использовать UpdateAlias для изменения имени псевдонима. Чтобы изменить имя псевдонима, используйте DeleteAlias для удаления старого псевдонима и CreateAlias для создания нового псевдонима.

Поскольку псевдоним не является свойством ключа KMS, вы можете создавать, обновлять и удалять псевдонимы ключа KMS, не затрагивая сам ключ KMS. Кроме того, псевдонимы не отображаются в ответе от операции DescribeKey. Чтобы получить псевдонимы всех ключей KMS в учетной записи, используйте операцию ListAliases.

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

• kms:UpdateAlias для псевдонима (политика IAM).
• kms:UpdateAlias для текущего ключа KMS (политика ключа).
• kms:UpdateAlias для нового ключа KMS (политика ключа).

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

• CreateAlias
• DeleteAlias
• ListAliases

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

Синтаксис

  update-alias
--alias-name <value>
--target-key-id <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]

Параметры

--alias-name (строка)

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

--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 (string)

Переопределить URL по умолчанию команды указанным URL.

--no-verify-ssl (boolean)

По умолчанию AWS CLI использует SSL при общении с AWS-сервисами. Для каждого SSL-соединения AWS CLI проверяет сертификаты SSL. Этот параметр переопределяет поведение проверки сертификатов SSL по умолчанию.

--no-paginate (boolean)

Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один вызов для первой страницы результатов.

--output (string)

Стиль форматирования вывода команды.

• json
• text
• table
• yaml
• yaml-stream

--query (string)

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

--profile (string)

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

--region (string)

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

--version (string)

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

--color (string)

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

• on
• off
• auto

--no-sign-request (boolean)

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

--ca-bundle (string)

Файл-сборка сертификатов CA для проверки сертификатов SSL. Переопределяет настройки конфигурации/среды.

--cli-read-timeout (int)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию составляет 60 секунд.

--cli-connect-timeout (int)

Максимальное время подключения сокета в секундах. Если значение установлено в 0, подключение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию составляет 60 секунд.

--cli-binary-format (string)

Стиль форматирования, используемый для бинарных блоков. Формат по умолчанию — base64. Формат base64 ожидает, что бинарные блоки будут предоставлены как строка в кодировке base64. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI версии 1, и бинарные значения должны передаваться буквально. При предоставлении содержимого из файла, соответствующего бинарному блоку fileb:// всегда будет обрабатываться как бинарный и будет использовать содержимое файла напрямую независимо от настройки cli-binary-format. При использовании file:// содержимое файла должно быть должным образом отформатировано для настроенного cli-binary-format.

• base64
• raw-in-base64-out

--no-cli-pager (boolean)

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

--cli-auto-prompt (boolean)

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

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

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

Примеры

Для привязки псевдонима к другому ключу KMS

Следующий update-alias пример привязывает псевдоним alias/test-key к другому ключу KMS.

• Параметр --alias-name задает псевдоним. Имя псевдонима должно начинаться с alias/.

• Параметр --target-key-id задает ключ KMS, который нужно привязать к псевдониму. Вам не нужно указывать текущий ключ KMS для псевдонима.

  aws kms update-alias \
      --alias-name alias/test-key \
      --target-key-id 1234abcd-12ab-34cd-56ef-1234567890ab
  

Эта команда не выводит ничего. Чтобы найти псевдоним, используйте команду list-aliases.

Дополнительную информацию см. в разделе Обновление псевдонимов в Руководстве разработчика AWS Key Management Service.

Вывод

Нет