Class CryptoKey (2.17.0)

CryptoKey(mapping=None, *, ignore_unknown_fields=False, **kwargs)

A CryptoKey represents a logical key that can be used for cryptographic operations.

A CryptoKey is made up of zero or more versions, which represent the actual key material used in cryptographic operations.

.. _oneof:


name str
Output only. The resource name for this CryptoKey in the format projects/*/locations/*/keyRings/*/cryptoKeys/*.
Output only. A copy of the "primary" CryptoKeyVersion that will be used by Encrypt when this CryptoKey is given in The CryptoKey's primary version can be updated via UpdateCryptoKeyPrimaryVersion. Keys with purpose ENCRYPT_DECRYPT may have a primary. For other keys, this field will be omitted.
Immutable. The immutable purpose of this CryptoKey.
create_time google.protobuf.timestamp_pb2.Timestamp
Output only. The time at which this CryptoKey was created.
next_rotation_time google.protobuf.timestamp_pb2.Timestamp
At next_rotation_time, the Key Management Service will automatically: 1. Create a new version of this CryptoKey. 2. Mark the new version as primary. Key rotations performed manually via CreateCryptoKeyVersion and UpdateCryptoKeyPrimaryVersion do not affect next_rotation_time. Keys with purpose ENCRYPT_DECRYPT support automatic rotation. For other keys, this field must be omitted.
rotation_period google.protobuf.duration_pb2.Duration
next_rotation_time will be advanced by this period when the service automatically rotates a key. Must be at least 24 hours and at most 876,000 hours. If rotation_period is set, next_rotation_time must also be set. Keys with purpose ENCRYPT_DECRYPT support automatic rotation. For other keys, this field must be omitted. This field is a member of oneof_ rotation_schedule.
A template describing settings for new CryptoKeyVersion instances. The properties of new CryptoKeyVersion instances created by either CreateCryptoKeyVersion or auto-rotation are controlled by this template.
labels MutableMapping[str, str]
Labels with user-defined metadata. For more information, see `Labeling Keys
import_only bool
Immutable. Whether this key may contain imported versions only.
destroy_scheduled_duration google.protobuf.duration_pb2.Duration
Immutable. The period of time that versions of this key spend in the DESTROY_SCHEDULED state before transitioning to DESTROYED. If not specified at creation time, the default duration is 24 hours.
crypto_key_backend str
Immutable. The resource name of the backend environment where the key material for all CryptoKeyVersions associated with this CryptoKey reside and where all related cryptographic operations are performed. Only applicable if CryptoKeyVersions have a ProtectionLevel of EXTERNAL_VPC][CryptoKeyVersion.ProtectionLevel.EXTERNAL_VPC], with the resource name in the format projects/*/locations/*/ekmConnections/*. Note, this list is non-exhaustive and may apply to additional ProtectionLevels in the future.




CryptoKeyPurpose describes the cryptographic capabilities of a CryptoKey. A given key can only be used for the operations allowed by its purpose. For more information, see Key purposes <>__.

Values: CRYPTO_KEY_PURPOSE_UNSPECIFIED (0): Not specified. ENCRYPT_DECRYPT (1): CryptoKeys with this purpose may be used with Encrypt and Decrypt. ASYMMETRIC_SIGN (5): CryptoKeys with this purpose may be used with AsymmetricSign and GetPublicKey. ASYMMETRIC_DECRYPT (6): CryptoKeys with this purpose may be used with AsymmetricDecrypt and GetPublicKey. MAC (9): CryptoKeys with this purpose may be used with MacSign.


LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

kwargs dict

Keys and values corresponding to the fields of the message.

mapping Union[dict, .Message]

A dictionary or message to be used to determine the values for this message.

ignore_unknown_fields Optional(bool)

If True, do not raise errors for unknown fields. Only applied if mapping is a mapping type or there are keyword parameters.