отключение-пользовательского-хранилища-ключей

Описание

Отключает пользовательское хранилище ключей от его базового хранилища ключей. Данная операция отключает хранилище ключей CloudHSM от связанного кластера CloudHSM или отключает внешнее хранилище ключей от прокси внешнего хранилища ключей, взаимодействующего с вашим внешним менеджером ключей.

Данная операция является частью функции пользовательских хранилищ ключей в KMS, которая объединяет удобство и обширную интеграцию KMS с изоляцией и контролем хранилища ключей, которым вы владеете и управляете.

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

Примечание

Пока пользовательское хранилище ключей отключено, все попытки создания ключей KMS в пользовательском хранилище или использования существующих ключей KMS в криптографических операциях завершатся ошибкой. Это действие может предотвратить хранение и доступ к конфиденциальным данным.

При отключении пользовательского хранилища ключей его ConnectionState изменяется на Disconnected . Чтобы определить состояние подключения пользовательского хранилища ключей, используйте операцию DescribeCustomKeyStores. Чтобы подключить пользовательское хранилище ключей, используйте операцию ConnectCustomKeyStore.

Если операция выполнена успешно, она возвращает JSON-объект без свойств.

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

Требуемые разрешения : kms:DisconnectCustomKeyStore (политика IAM)

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

ConnectCustomKeyStore
CreateCustomKeyStore
DeleteCustomKeyStore
DescribeCustomKeyStores
UpdateCustomKeyStore

Постепенная согласованность : API KMS следует модели постепенной согласованности. Для получения дополнительной информации см. постепенную согласованность KMS .

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

Синтаксис

  disconnect-custom-key-store
--custom-key-store-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]

Параметры

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

Введите ID пользовательского хранилища ключей, которое требуется отключить. Чтобы найти ID пользовательского хранилища ключей, используйте операцию DescribeCustomKeyStores.

--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
text
table
yaml
yaml-stream

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

Чтобы отключить пользовательское хранилище ключей

Следующий disconnect-custom-key-store пример отключает пользовательское хранилище ключей от своего кластера AWS CloudHSM. Вы можете отключить хранилище ключей для устранения неполадок, обновления настроек или предотвращения использования ключей KMS в хранилище в криптографических операциях.

Эта команда одинакова для всех пользовательских хранилищ ключей, включая хранилища ключей AWS CloudHSM и внешние хранилища ключей.

Перед запуском этой команды замените пример ID пользовательского хранилища ключей на действительный.

$ aws kms disconnect-custom-key-store \
    --custom-key-store-id cks-1234567890abcdef0

Эта команда не выводит ничего. Чтобы проверить, что команда выполнена успешно, используйте describe-custom-key-stores команду.

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

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

Вывод

Нет