crypto_keys

Overview

Name	crypto_keys
Type	Resource
Id	google.cloudkms.crypto_keys

Fields

Name	Datatype	Description
name	string	Output only. The resource name for this CryptoKey in the format projects/*/locations/*/keyRings/*/cryptoKeys/*.
createTime	string	Output only. The time at which this CryptoKey was created.
cryptoKeyBackend	string	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, 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.
destroyScheduledDuration	string	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.
importOnly	boolean	Immutable. Whether this key may contain imported versions only.
labels	object	Labels with user-defined metadata. For more information, see Labeling Keys.
nextRotationTime	string	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.
primary	object	A CryptoKeyVersion represents an individual cryptographic key, and the associated key material. An ENABLED version can be used for cryptographic operations. For security reasons, the raw cryptographic key material represented by a CryptoKeyVersion can never be viewed or exported. It can only be used to encrypt, decrypt, or sign data when an authorized user or application invokes Cloud KMS.
purpose	string	Immutable. The immutable purpose of this CryptoKey.
rotationPeriod	string	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.
versionTemplate	object	A CryptoKeyVersionTemplate specifies the properties to use when creating a new CryptoKeyVersion, either manually with CreateCryptoKeyVersion or automatically as a result of auto-rotation.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	cryptoKeysId, keyRingsId, locationsId, projectsId	Returns metadata for a given CryptoKey, as well as its primary CryptoKeyVersion.
list	SELECT	keyRingsId, locationsId, projectsId	Lists CryptoKeys.
create	INSERT	keyRingsId, locationsId, projectsId	Create a new CryptoKey within a KeyRing. CryptoKey.purpose and CryptoKey.version_template.algorithm are required.
_list	EXEC	keyRingsId, locationsId, projectsId	Lists CryptoKeys.
decrypt	EXEC	cryptoKeysId, keyRingsId, locationsId, projectsId	Decrypts data that was protected by Encrypt. The CryptoKey.purpose must be ENCRYPT_DECRYPT.
encrypt	EXEC	cryptoKeysId, keyRingsId, locationsId, projectsId	Encrypts data, so that it can only be recovered by a call to Decrypt. The CryptoKey.purpose must be ENCRYPT_DECRYPT.
patch	EXEC	cryptoKeysId, keyRingsId, locationsId, projectsId	Update a CryptoKey.