Spec-Zone.ru › AWS CLI v2

[ aws . payment-cryptography ]

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

Описание

Создаёт псевдоним, или дружественное имя, для ключа Amazon Web Services Payment Cryptography. Вы можете использовать псевдоним для идентификации ключа в консоли и при вызове криптографических операций, таких как EncryptData или DecryptData.

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

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

Использование между аккаунтами : Эта операция не может быть использована между разными аккаунтами Amazon Web Services.

Связанные операции:

  • DeleteAlias
  • GetAlias
  • ListAliases
  • UpdateAlias

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

Синтаксис

  create-alias
--alias-name <value>
[--key-arn <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 (строка)

Дружественное имя, которое вы можете использовать для ссылки на ключ. Псевдоним должен начинаться с alias/, за которым следует имя, например alias/ExampleAlias. Он может содержать только буквенно-цифровые символы, косые черты (/), подчёркивания (_) и дефисы (-).

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

Не включайте личную, конфиденциальную или чувствительную информацию в это поле. Это поле может быть отображено в виде открытого текста в логах CloudTrail и других выводах.

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

Уникальный KeyARN ключа, который нужно связать с псевдонимом.

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

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

Следующий create-alias пример создаёт псевдоним для ключа.

aws payment-cryptography create-alias \
    --alias-name alias/sampleAlias1 \
    --key-arn arn:aws:payment-cryptography:us-east-2:123456789012:key/kwapwa6qaifllw2h

Вывод:

{
    "Alias": {
        "AliasName": "alias/sampleAlias1",
        "KeyArn": "arn:aws:payment-cryptography:us-west-2:123456789012:key/kwapwa6qaifllw2h"
    }
}

Дополнительную информацию см. в разделе О псевдонимах в Руководстве пользователя AWS Payment Cryptography.

Вывод

Псевдоним -> (структура)

Псевдоним для ключа.

AliasName -> (строка)

Дружественное имя, которое вы можете использовать для ссылки на ключ. Значение должно начинаться с alias/.

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

Не включайте конфиденциальную или чувствительную информацию в это поле. Это поле может отображаться в открытом виде в логах CloudTrail и других выводах.

KeyArn -> (строка)

Уникальный KeyARN ключа, связанного с псевдонимом.

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

Spec-Zone.ru

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