Spec-Zone.ru › AWS CLI v2

[ aws . kms ]

disable-key-rotation

Описание

Отключает автоматическое вращение материала ключа указанного симметричного ключа KMS.

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

Вы можете включить ( EnableKeyRotation ) и отключить автоматическое вращение ключевого материала в управляемых клиентом ключах KMS. Вращение ключевого материала управляемых Amazon Web Services ключей KMS настраивается. KMS всегда вращает ключевой материал каждый год. Вращение ключей KMS, принадлежащих Amazon Web Services, варьируется.

Примечание

В мае 2022 года KMS изменил график вращения управляемых Amazon Web Services ключей с каждых трех лет на ежегодный. Подробнее см. EnableKeyRotation .

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

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

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

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

  • EnableKeyRotation
  • GetKeyRotationStatus
  • ListKeyRotations
  • RotateKeyOnDemand
Постепенная согласованность : API KMS следует модели постепенной согласованности. Дополнительную информацию см. в разделе Постепенная согласованность KMS.

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

Синтаксис

  disable-key-rotation
--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]

Параметры

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

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

Укажите идентификатор или ARN ключа KMS.

Например:

  • Идентификатор ключа: 1234abcd-12ab-34cd-56ef-1234567890ab
  • ARN ключа: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

Чтобы получить идентификатор и ARN ключа KMS, используйте ListKeys или DescribeKey .

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

Чтобы отключить автоматическое вращение ключа KMS

Следующий disable-key-rotation пример отключает автоматическое вращение ключа KMS, управляемого клиентом. Чтобы снова включить автоматическое вращение, используйте команду enable-key-rotation.

aws kms disable-key-rotation \
    --key-id arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

Эта команда не выводит ничего. Чтобы проверить, что автоматическое вращение отключено для ключа KMS, используйте команду get-key-rotation-status.

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

Вывод

Нет

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

Spec-Zone.ru

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