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

Описание

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

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

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

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

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

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

• ConnectCustomKeyStore
• CreateCustomKeyStore
• DescribeCustomKeyStores
• DisconnectCustomKeyStore
• UpdateCustomKeyStore

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

Синтаксис

  delete-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 (строка)

--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 (строка)

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

• on
• off
• auto

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

Примеры

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

Следующий delete-custom-key-store пример удаляет указанное пользовательское хранилище ключей.

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

ПРИМЕЧАНИЕ: перед удалением пользовательского хранилища ключей необходимо запланировать удаление всех ключей KMS в пользовательском хранилище ключей, а затем дождаться удаления этих ключей KMS. Затем необходимо отключить пользовательское хранилище ключей. Для получения помощи в поиске ключей KMS в вашем пользовательском хранилище ключей см. Удаление хранилища ключей AWS CloudHSM (API) в руководстве разработчика AWS Key Management Service.

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

Вывод

Нет