get-key-rotation-status

Описание

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

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

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

Вы можете выполнить вращение ключевого материала по требованию ( RotateKeyOnDemand ) в управляемых клиентом ключах KMS независимо от того, включено ли автоматическое вращение ключа. Вы можете использовать GetKeyRotationStatus для определения даты и времени инициирования текущего вращения по требованию. Вы можете использовать ListKeyRotations для просмотра подробностей завершенных вращений.

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

• Выключено: Статус вращения ключа не изменяется при отключении ключа KMS. Однако, пока ключ KMS отключён, KMS не вращает ключевой материал. При повторном включении ключа KMS вращение возобновляется. Если ключевой материал в повторно включённом ключе KMS не был изменён в течение года, KMS немедленно вращает его и далее ежегодно. Если с момента последнего вращения ключевого материала в повторно включённом ключе KMS прошло менее года, ключ KMS возобновляет свой предыдущий график вращения.
• Ожидание удаления: Пока ключ KMS находится в ожидании удаления, его статус вращения ключа является false, и KMS не вращает ключевой материал. Если вы отменяете удаление, исходный статус вращения ключа возвращается к true.

• DisableKeyRotation
• EnableKeyRotation
• ListKeyRotations
• RotateKeyOnDemand

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

Синтаксис

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

--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 версии 1, и двоичные значения должны передаваться буквально. При предоставлении содержимого файла, сопоставленного с двоичным блоком, 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.

Следующий пример get-key-rotation-status возвращает информацию о статусе вращения указанного ключа KMS, включая включение автоматического вращения, период вращения и следующую запланированную дату вращения. Вы можете использовать эту команду для управляемых клиентом ключей KMS и управляемых AWS ключей KMS. Однако все управляемые AWS ключи KMS автоматически вращаются ежегодно.

aws kms get-key-rotation-status \
    --key-id 1234abcd-12ab-34cd-56ef-1234567890ab

Вывод:

{
    "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab",
    "KeyRotationEnabled": true,
    "NextRotationDate": "2024-02-14T18:14:33.587000+00:00",
    "RotationPeriodInDays": 365
}

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

Вывод

KeyRotationEnabled -> (булево)

KeyId -> (строка)

RotationPeriodInDays -> (целое число)

NextRotationDate -> (отметка времени)

OnDemandRotationStartDate -> (отметка времени)