REST Resource: projects.locations.keyRings.cryptoKeys

Recurso: CryptoKey

Un CryptoKey representa una clave lógica que se puede usar para operaciones criptográficas.

Un CryptoKey se compone de cero o más versions, que representan el material de clave real que se usa en las operaciones criptográficas.

Representación JSON 
{
  "name": string,
  "primary": {
    object (CryptoKeyVersion)
  },
  "purpose": enum (CryptoKeyPurpose),
  "createTime": string,
  "nextRotationTime": string,
  "versionTemplate": {
    object (CryptoKeyVersionTemplate)
  },
  "labels": {
    string: string,
    ...
  },
  "importOnly": boolean,
  "destroyScheduledDuration": string,
  "cryptoKeyBackend": string,

  // Union field rotation_schedule can be only one of the following:
  "rotationPeriod": string
  // End of list of possible types for union field rotation_schedule.
}
Campos
name

string

Solo salida. El nombre del recurso para este CryptoKey en el formato projects/*/locations/*/keyRings/*/cryptoKeys/*.
primary

object (CryptoKeyVersion)

Solo salida. Una copia del objeto CryptoKeyVersion "principal" que usará [Encrypt][KeyManagementService.Encrypt] cuando se proporcione esta CryptoKey en [EncryptRequest.name][].

La versión principal de CryptoKey se puede actualizar con [UpdateCryptoKeyPrimaryVersion][KeyManagementService.UpdateCryptoKeyPrimaryVersion].

Las claves con purpose ENCRYPT_DECRYPT pueden tener una principal. Este campo se omite para las otras claves.
purpose

enum (CryptoKeyPurpose)

Inmutable. El propósito inmutable de este CryptoKey
createTime

string (Timestamp format)

Solo salida. La hora en la que se creó este CryptoKey.

Una marca de tiempo en formato RFC3339 UTC “Zulú”, con una resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z".
nextRotationTime

string (Timestamp format)

En nextRotationTime, el servicio de administración de claves realizará automáticamente lo siguiente:

  1. Crea una nueva versión de este dispositivo CryptoKey.
  2. Marcar la versión nueva como primaria

Las rotaciones de claves realizadas manualmente a través de [CreateCryptoKeyVersion][KeyManagementService.CreateCryptoKeyVersion] y [UpdateCryptoKeyPrimaryVersion][KeyManagementService.UpdateCryptoKeyPrimaryVersion] no afectan a nextRotationTime.

Las claves con purpose ENCRYPT_DECRYPT admiten la rotación automática. Este campo se debe omitir en las otras claves.

Una marca de tiempo en formato RFC3339 UTC “Zulú”, con una resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z".
versionTemplate

object (CryptoKeyVersionTemplate)

Una plantilla que describe la configuración de las nuevas instancias de CryptoKeyVersion. Esta plantilla controla las propiedades de las nuevas instancias de CryptoKeyVersion creadas por [CreateCryptoKeyVersion][KeyManagementService.CreateCryptoKeyVersion] o la rotación automática.
labels

map (key: string, value: string)

Etiquetas con metadatos definidos por el usuario. Consulta Etiquetar claves para obtener más información.
importOnly

boolean

Inmutable. Indica si esta clave solo puede contener versiones importadas.
destroyScheduledDuration

string (Duration format)

Inmutable. El período que las versiones de esta clave pasan en el estado DESTROY_SCHEDULED antes de hacer la transición a DESTROYED. Si no se especifica en el momento de la creación, la duración predeterminada es de 24 horas.

Una duración en segundos con hasta nueve dígitos decimales, que terminan en “s”. Ejemplo: "3.5s".
cryptoKeyBackend

string

Inmutable. El nombre del recurso del entorno de backend donde reside el material de claves de todos los CryptoKeyVersions asociados con esta CryptoKey y donde se realizan todas las operaciones criptográficas relacionadas. Solo se aplica si CryptoKeyVersions tiene una ProtectionLevel de [EXTERNAL_VPC][CryptoKeyVersion.ProtectionLevel.EXTERNAL_VPC], con el nombre del recurso en el formato projects/*/locations/*/ekmConnections/*. Ten en cuenta que esta lista no es exhaustiva y puede aplicarse a ProtectionLevels adicionales en el futuro.
Campo de unión rotation_schedule. Controla la velocidad de rotación automática. rotation_schedule puede ser solo uno de los siguientes:
rotationPeriod

string (Duration format)

nextRotationTime se adelantará antes de este período cuando el servicio rote una clave automáticamente. Debe ser un mínimo de 24 horas y un máximo de 876,000 horas.

Si se configura rotationPeriod, también se debe establecer nextRotationTime.

Las claves con purpose ENCRYPT_DECRYPT admiten la rotación automática. Este campo se debe omitir en las otras claves.

Una duración en segundos con hasta nueve dígitos decimales, que terminan en “s”. Ejemplo: "3.5s".

Métodos

getProtectedResourcesSummary

 Muestra información agregada sobre los recursos protegidos por el CryptoKey de Cloud KMS especificado.