create-alias

Описание

Создаёт псевдоним для ключа KMS.

Вы можете использовать псевдоним для идентификации ключа KMS в консоли KMS, в операции DescribeKey и в криптографических операциях, таких как Encrypt и GenerateDataKey. Вы также можете изменить ключ KMS, связанный с псевдонимом ( UpdateAlias ), или удалить псевдоним ( DeleteAlias ) в любое время. Эти операции не влияют на базовый ключ KMS.

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

Псевдоним должен быть уникальным в рамках учётной записи и региона, но вы можете иметь псевдонимы с одинаковым именем в разных регионах. Подробную информацию о псевдонимах см. в руководстве разработчика службы управления ключами (Using aliases).

Эта операция не возвращает ответа. Чтобы получить созданный псевдоним, используйте операцию ListAliases.

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

• kms:CreateAlias на псевдоним (политика IAM).
• kms:CreateAlias на ключ KMS (политика ключа).

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

• DeleteAlias
• ListAliases
• UpdateAlias

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

Синопсис

  create-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 (логическое)

Включить отладку.

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

Примеры

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

Следующая create-alias команда создаёт псевдоним, названный example-alias, для ключа KMS, идентифицированного по ID ключа 1234abcd-12ab-34cd-56ef-1234567890ab.

Имена псевдонимов должны начинаться с alias/. Не используйте имена псевдонимов, начинающиеся с alias/aws; они зарезервированы для использования AWS.

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

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

Дополнительную информацию см. в руководстве разработчика службы управления ключами AWS (Using aliases).

Вывод

Нет