SymmetricKey
Набор методов для управления симметричными ключами KMS.
JSON-представление
{
"id": "string",
"folderId": "string",
"createdAt": "string",
"name": "string",
"description": "string",
"labels": "object",
"status": "string",
"primaryVersion": {
"id": "string",
"keyId": "string",
"status": "string",
"algorithm": "string",
"createdAt": "string",
"primary": true,
"destroyAt": "string"
},
"defaultAlgorithm": "string",
"rotatedAt": "string",
"rotationPeriod": "string",
"deletionProtection": true
}
Поле | Описание |
---|---|
id | string Идентификатор ключа. |
folderId | string Идентификатор каталога, которому принадлежит ключ. |
createdAt | string (date-time) Время создания ключа. Строка в формате RFC3339. |
name | string Имя симметричного ключа. |
description | string Описание симметричного ключа. |
labels | object Пользовательские метки для ключа в виде пар |
status | string Текущий статус ключа. |
primaryVersion | object Основная версия ключа, используемая по умолчанию для всех операций шифрования, когда идентификатор версии не указан явно. Версия симметричного ключа KMS: метаданные криптографического материала. |
primaryVersion. id |
string Идентификатор версии ключа. |
primaryVersion. keyId |
string Идентификатор симметричного ключа KMS, которому принадлежит версия. |
primaryVersion. status |
string Состояние версии ключа. Возможные статусы версии.
|
primaryVersion. algorithm |
string Алгоритм шифрования, который следует использовать при использовании этой версии ключа для шифрования. Поддерживаемые алгоритмы симметричного шифрования.
|
primaryVersion. createdAt |
string (date-time) Время создания версии ключа. Строка в формате RFC3339. |
primaryVersion. primary |
boolean (boolean) Признак основной версии, которая должна использоваться по умолчанию для всех криптографических операций, для которых явно не указана версия ключа. |
primaryVersion. destroyAt |
string (date-time) Время, когда версия ключа будет уничтожена. Пустой, если статус не Строка в формате RFC3339. |
defaultAlgorithm | string Алгоритм шифрования по умолчанию, который следует использовать с новыми версиями ключа. Поддерживаемые алгоритмы симметричного шифрования.
|
rotatedAt | string (date-time) Время последней ротации ключа (время, когда была создана последняя версия). Пустое, если у ключа еще нет версий. Строка в формате RFC3339. |
rotationPeriod | string Период времени между автоматическими ротациями ключа. |
deletionProtection | boolean (boolean) Флаг, запрещающий удаление ключа |
Методы
Метод | Описание |
---|---|
cancelVersionDestruction | Отменяет ранее запланированное уничтожение версии, если версия еще не была уничтожена. |
create | Создает симметричный ключ KMS в указанном каталоге. |
delete | Удаляет указанный симметричный ключ KMS. Это действие также автоматически планирует уничтожение всех версий ключа через 72 часа. |
get | Возвращает указанный симметричный ключ KMS. |
list | Возвращает список симметричных ключей KMS в указанном каталоге. |
listAccessBindings | Возвращает список привязок прав доступа для указанного симметричного ключа KMS. |
listOperations | Возвращет список операций для указанного симметричного ключа KMS. |
listVersions | Возвращает список версий указанного симметричного ключа KMS. |
rotate | Ротирует указанный ключ: создает новую версию ключа и делает ее основной. Старая версия остается доступной для расшифровки зашифрованных с ее помощью данных. |
scheduleVersionDestruction | Планирует уничтожение указанной версии ключа. |
setAccessBindings | Устанавливает привязки прав доступа для указанного симметричного ключа KMS. |
setPrimaryVersion | Задает основную версию для указанного ключа. Основная версия используется по умолчанию для всех операций шифрования / дешифрования, в которых не указан идентификатор версии. |
update | Изменяет указанный симметричный ключ KMS. |
updateAccessBindings | Обновляет привязки прав доступа для указанного симметричного ключа KMS. |